AcademicRecordsStudentStatusInfo
This service provides enrollment status, GPA, and contact information about a student.
Base URL: /domains/legacy/academic/records/studentstatusinfo
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /{id_type}/{id} | GET | Get current status |
| /{id_type}/{id}/{year_term} | GET | Get year status |
Paths
Get current status
| id_type | Identification type -> netid, byuid, or personid | path | string | |
| id | 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": "/netid/netid_name",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"address_line_1": "address",
"address_line_2": "",
"address_line_3": "",
"address_line_4": "",
"byu_gpa": "2.65",
"byu_id": "123456789",
"city": "Provo",
"country_code": "USA",
"country_name": "United States of America",
"current_year_term": "20181",
"eligible_to_register": "Y",
"email_address": "email",
"enrollment_hours": "6.5",
"enrollment_status": "Half-time",
"enrollment_year_term": "20181",
"gpa_list": [
{
"earned_hours": "6.0",
"graded_hours": "6.0",
"term_gpa": "2.20",
"year_term": "20175"
}
],
"graded_hours": "126.5",
"net_id": "netid_name",
"person_id": "123456789",
"phone_number": "",
"postal_code": "84606",
"reg_eligibility": "DC",
"reg_status": "9",
"state_code": "UT",
"state_name": "Utah",
"student_level": "U",
"student_name": "Student, Name",
"total_gpa": "2.65",
"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 year status
| id_type | Identification type | path | string | |
| id | Identification | path | string | |
| year_term | Specific year and term, YYYYT | 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": "/netid/netid_name",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"address_line_1": "address",
"address_line_2": "",
"address_line_3": "",
"address_line_4": "",
"byu_gpa": "2.65",
"byu_id": "123456789",
"city": "Provo",
"country_code": "USA",
"country_name": "United States of America",
"current_year_term": "20181",
"eligible_to_register": "Y",
"email_address": "email",
"enrollment_hours": "6.5",
"enrollment_status": "Half-time",
"enrollment_year_term": "20181",
"gpa_list": [
{
"earned_hours": "6.0",
"graded_hours": "6.0",
"term_gpa": "2.20",
"year_term": "20175"
}
],
"graded_hours": "126.5",
"net_id": "netid_name",
"person_id": "123456789",
"phone_number": "",
"postal_code": "84606",
"reg_eligibility": "DC",
"reg_status": "9",
"state_code": "UT",
"state_name": "Utah",
"student_level": "U",
"student_name": "Student, Name",
"total_gpa": "2.65",
"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.
Schema definitions
The GPA of each year/term
- year_term: year_term
-
- term_gpa: term_gpa
-
- earned_hours: earned_hours
-
- graded_hours: gpa_graded_hours
-
The outline of the request
- method: method
-
- resource: resource
-
- attributes: attributes
-
- status: status
-
- statusMessage: statusMessage
-
The response of the request
- person_id: person_id
-
- byu_id: byu_id
-
- net_id: net_id
-
- student_name: student_name
-
- student_level: student_level
-
- total_hours: total_hours
-
- graded_hours: graded_hours
-
- total_gpa: total_gpa
-
- byu_gpa: byu_gpa
-
- current_year_term: current_year_term
-
- enrollment_year_term: enrollment_year_term
-
- eligible_to_register: eligible_to_register
-
- enrollment_status: enrollment_status
-
- enrollment_hours: enrollment_hours
-
- reg_status: reg_status
-
- reg_eligibility: reg_eligibility
-
- gpa_list: gpa_list
-
- email_address: email_address
-
- address_line_1: address_line_1
-
- address_line_2: address_line_2
-
- address_line_3: address_line_3
-
- address_line_4: address_line_4
-
- city: city
-
- state_code: state_code
-
- state_name: state_name
-
- postal_code: postal_code
-
- country_code: country_code
-
- country_name: country_name
-
- phone_number: phone_number
-
