AcademicRecordsGPAComp

AcademicRecordsGPAComp

This service computes a possible GPA based on future projected performance.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/academic/records/gpacomp

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/ GET

Returns the current GPA status of the authenticated user OR Returns a the projected gpa with the projected or repeated grades included of the authenticated user.
/documentation GET

service definition
/{person_id} GET

Returns the current GPA status of student with the specified person id OR Returns a the projected gpa with the projected or repeated grades included of the student with the specified person id.

Paths

Returns the current GPA status of the authenticated user OR Returns a the projected gpa with the projected or repeated grades included of the authenticated user.

GET /

Tags: GPACompService

Returns the current GPA status of the authenticated user OR Returns a the projected gpa with the projected or repeated grades included of the authenticated user.
projected_set

comma separated value pairs of credits and grades (i.e. 2.0,A). Valid Grades: A,A-,B+,B,B-,C+,C,C-,D+,D,D-,E,UW,W

 query string
repeated_set

comma separated doubled value pairs of credits and grades (i.e. 2.0,C-,2.0,B+). Valid Grades: A,A-,B+,B,B-,C+,C,C-,D+,D,D-,E,UW,W

 query string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

RecGpaCompService
Example for application/json
{
    "request": {
        "attributes": "projected_set=3.0%2CA%2C2.0%2CB&repeated_set=3.0%2CA%2C3.0%2CC%2C4.0%2CB%2B%2C4.0%2CD",
        "method": "GET",
        "resource": "/123456789",
        "status": 200,
        "statusMessage": "Service request is OK and a response has been generated."
    },
    "response": {
        "BYU_credit_information": {
            "GPA": "2.63",
            "credit_hours": "129.50",
            "grade_points": "340.80"
        },
        "Note": "The effect of an individual course on your GPA diminishes as your total hours increase",
        "new_BYU_grades_after_repeats(s)": {
            "credit_hours": "74.00",
            "grade_points": "268.40"
        },
        "new_total_grades_after_repeat(s)": {
            "credit_hours": "86.00",
            "grade_points": "316.40"
        },
        "total_credit_information": {
            "GPA": "2.63",
            "credit_hours": "129.50",
            "grade_points": "340.80"
        },
        "warnings": ""
    }
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

The target resource can not be found for the provided resource identifiers.

ErrorResponse
405 Method Not Allowed

The service method is not supported by the service.

ErrorResponse
409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

ErrorResponse
500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

ErrorResponse
service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Returns the current GPA status of student with the specified person id OR Returns a the projected gpa with the projected or repeated grades included of the student with the specified person id.

GET /{person_id}

Tags: GPACompService

Returns the current GPA status of student with the specified person id OR Returns a the projected gpa with the projected or repeated grades included of the student with the specified person id.
person_id

string ->

path string
projected_set

comma separated value pairs of credits and grades (i.e. 2.0,A). Valid Grades: A,A-,B+,B,B-,C+,C,C-,D+,D,D-,E,UW,W

 query string
repeated_set

comma separated doubled value pairs of credits and grades (i.e. 2.0,C-,2.0,B+). Valid Grades: A,A-,B+,B,B-,C+,C,C-,D+,D,D-,E,UW,W

 query string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

RecGpaCompService
Example for application/json
{
    "request": {
        "attributes": "projected_set=3.0%2CA%2C2.0%2CB&repeated_set=3.0%2CA%2C3.0%2CC%2C4.0%2CB%2B%2C4.0%2CD",
        "method": "GET",
        "resource": "/123456789",
        "status": 200,
        "statusMessage": "Service request is OK and a response has been generated."
    },
    "response": {
        "BYU_credit_information": {
            "GPA": "2.63",
            "credit_hours": "129.50",
            "grade_points": "340.80"
        },
        "Note": "The effect of an individual course on your GPA diminishes as your total hours increase",
        "new_BYU_grades_after_repeats(s)": {
            "credit_hours": "74.00",
            "grade_points": "268.40"
        },
        "new_total_grades_after_repeat(s)": {
            "credit_hours": "86.00",
            "grade_points": "316.40"
        },
        "total_credit_information": {
            "GPA": "2.63",
            "credit_hours": "129.50",
            "grade_points": "340.80"
        },
        "warnings": ""
    }
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

The target resource can not be found for the provided resource identifiers.

ErrorResponse
405 Method Not Allowed

The service method is not supported by the service.

ErrorResponse
409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

ErrorResponse
500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

ErrorResponse

Schema definitions

BYU_credit_information: object

credit_hours: credit_hours
grade_points: grade_points
GPA: GPA

credit_hours: string

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

error_data

GPA: string

grade_points: string

new_BYU_grades_after_repeat: object

credit_hours: credit_hours
grade_points: grade_points

new_total_grades_after_repeat: object

credit_hours: credit_hours
grade_points: grade_points

Note: string

project_bresults: object

credit_hours: credit_hours
grade_points: grade_points

project_byu_results: object

credit_hours: credit_hours
grade_points: grade_points

projected_semester_results: object

credit_hours: credit_hours
grade_points: grade_points

RecGpaCompService: object

request: request
response: response

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

response: object

Note: Note
total_credit_information: total_credit_information
BYU_credit_information: BYU_credit_information
projected_semester_results: projected_semester_results
project_byu_results: project_byu_results
project_bresults: project_bresults
new_BYU_grades_after_repeat: new_BYU_grades_after_repeat
new_total_grades_after_repeat: new_total_grades_after_repeat
warnings: warnings

total_credit_information: object

credit_hours: credit_hours
grade_points: grade_points
GPA: GPA

warnings: string

Service Path: 
/domains/legacy/academic/records/gpacomp
Domain or University API: 
/domains/D/academic/records/gpacomp
Tags: 
domains
legacy
Academic
records
gpacomp

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access