AcademicRecordsStudentStatusInfo

This service provides enrollment status, GPA, and contact information about a student.

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

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

Version: v1

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

Summary

Path Operation Description
/{id_type}/{id} GET

Get current status

/{id_type}/{id}/{year_term} GET

Get year status

Paths

Get current status

GET /{id_type}/{id}

Tags: StudentStatusInfoService

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

GET /{id_type}/{id}/{year_term}

Tags: StudentStatusInfoService

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

address_line_1: string

The first address line of the student

address_line_2: string

The second address line of the student

address_line_3: string

The third address line of the student

address_line_4: string

The fourth address line of the student

attributes: string

byu_gpa: string

The BYU GPA

byu_id: string

The BYU ID of the student

city: string

The city of the student's address

country_code: string

The country code of the student's address

country_name: string

The country name of the student's address

current_year_term: string

Current term and year attending

earned_hours: string

The number of hours earned in the term

eligible_to_register: string

If the student is eligible to register

email_address: string

The email address of the student

enrollment_hours: string

The number of hours for enrollment

enrollment_status: string

The student's status of enrollment

enrollment_year_term: string

The term and year enrolled

gpa_graded_hours: string

The number of hours graded in the term

gpa_list: object[]

The GPA of each year/term

object
year_term: year_term
term_gpa: term_gpa
earned_hours: earned_hours
graded_hours: gpa_graded_hours

graded_hours: string

The total number of hours graded

method: string , x ∈ { GET , POST , PUT , DELETE }

The type of method called

net_id: string

The net ID of the student

person_id: string

The ID of the student

phone_number: string

The phone number of the student

postal_code: string

The postal code of the student's address

reg_eligibility: string

reg_status: string

request: object

The outline of the request

method: method
resource: resource
attributes: attributes
status: status
statusMessage: statusMessage

resource: string

Parameters used for the request

response: object

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

state_code: string

The state code of the student's address

state_name: string

The state name of the student's address

status: integer

The status code response

statusMessage: string

The message connected to the status code

student_level: string

student_name: string

The name of the student

StudentStatusInfoService: object

request: request
response: response

term_gpa: string

The GPA of the term

total_gpa: string

The overall GPA

total_hours: string

The total number of hours taken

year_term: string

A specific term

Service Path: 
/domains/legacy/academic/records/studentstatusinfo
Domain or University API: 
/domains/D/academic/records/studentstatusinfo

Community

 

Don't see your question listed here? Ask!