AcademicRecordsStandingHistory
This service returns a student's complete academic standing history from the AIM System.
Base URL: /domains/legacy/academic/records/standinghistory
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/documentation | GET | service definition |
/{person_id} | GET | Shows current academic standing identified by person id OR Updates a students academic standing current/previous by person id OR Updates the student's Threshold date |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{person_id}
Tags: StandingHistoryServiceShows current academic standing identified by person id OR Updates a students academic standing current/previous by person id OR Updates the student's Threshold date
person_id | string -> nine digit number | path | string | |
year_term | string -> year and term specified | query | string | |
new_standing | string -> new academic standing | query | string | |
threshold_date | string -> DD MM YYYY | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"academic_standings": [
{
"byu_gpa_original": 2.79,
"standing": "GOOD",
"term_gpa": 3.17,
"term_gpa_orig": 3.17,
"term_graded_hours": 14.5,
"year_term": "20151",
"year_term_desc": "Winter Semester 2015"
}
],
"current_standing": "GOOD",
"has_block": false,
"logs": [
],
"threshold_date": "08 Jan 2018"
}
} - 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.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 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.
Schema definitions
- year_term: year_term
-
- year_term_desc: year_term_desc
-
- term_gpa_orig: term_gpa_orig
-
- term_gpa: term_gpa
-
- term_graded_hours: term_graded_hours
-
- byu_gpa_original: byu_gpa_original
-
- standing: standing
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- current_standing: current_standing
-
- threshold_date: threshold_date
-
- has_block: has_block
-
- academic_standings: academic_standings
-
- logs: logs
-