AcademicAdvisementStudentGraduationApp

This service accesses advisement logs using the AIM system.

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

Base URL: /domains/legacy/academic/advisement/studentgraduationapp

Version: v1

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

Summary

Path Operation Description
/ GET

Returns the graduation application and status of the authenticated user

/{person_id} GET

Returns the graduation application and status of the user specified by the person id or net id

Paths

Returns the graduation application and status of the authenticated user

GET /

Tags: StudentGraduationAppService

An identical call to the next path, the difference is it pulls the id from whoever is logged in

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": "/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"programs": [
{
"applied_status": "",
"degree": "BS",
"degree_level": 4,
"major": "Computer Science",
"program_code": 693220
}
]
}
}
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.

Returns the graduation application and status of the user specified by the person id or net id

GET /{person_id}

Tags: StudentGraduationAppService

Returns the graduation application and status of the user specified by the person id or net id

person_id

string representing the person id attached to the BYU account. Net id can also be used.

path string , { x | x ≤ 9 }

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": "/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"programs": [
{
"applied_status": "",
"degree": "BS",
"degree_level": 4,
"major": "Computer Science",
"program_code": 693220
}
]
}
}
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

StdGraduationApp: object

StdGraduationRequest: object

method: string

REST method for request service.

resource: string

A resource

attributes: string
status: number

Return status of a REST request to determine success.

statusMessage: string

Explanation of return status of request.

StdGraduationResponse: object

programs: object[]
object
major: string
degree: string
degree_level: number
program_code: number
applied_status: string
Service Path: 
/domains/legacy/academic/advisement/studentgraduationapp
Domain or University API: 
/domains/D/academic/advisement/studentgraduationapp

Community

 

Don't see your question listed here? Ask!