AcademicRecordsStudentStandingInfo
This service provides the following information about a student: 1) their graduate/undergraduate status and 2) if an undergraduate, how many hours they have accumulated. The service allows for the submission of up to 200 IDs at a time (valid ID types that can be requested are: Net ID, BYU ID and Person ID).
Base URL: /domains/legacy/academic/records/studentstandinginfo
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{action}/{id type}/{id_id_list} | GET | Get standing single |
| /{action}/{package id} | GET | Get standing result |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
Get standing single
| action | Determines action to take | path | string | |
| id type | Identification type -> netid, byuid, or personid | path | string | |
| id_id_list | Identification OR list | path | 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/single/netid/netid_name/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"byu_id": "123456789",
"net_id": "netid_name",
"person_id": "123456789",
"student_level": "U",
"student_name": "Student, Name",
"total_hours": "128.0"
}
} - 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.
- 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.
Get standing result
| action | Determines action to take | path | string | |
| package id | package identification | path | 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": "/result/1",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"package_id": 1,
"request_count": 0,
"standing_list": [
]
}
} - 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.
- 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
- method: string
-
- resource: string
-
- attributes: string
-
- status: integer
-
- statusMessage: string
-
- person_id: person_id
-
- byu_id: byu_id
-
- net_id: net_id
-
- student_name: student_name
-
- student_level: student_level
-
- total_hours: total_hours
-
- package_id: package_id
-
- request_count: request_count
-
- standing_list: standing_list
-
- request: request
-
- response: responsePackage
-
