AcademicAdvisementStdDownload

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/stddownload

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{program_code_list} GET

Returns a list of students in a program for the current year term. Ordered alphabetically by major.

/{program_code_list}/{year_term} GET

Returns a list of students and their graduation status. Ordered alphabetically by program.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Returns a list of students in a program for the current year term. Ordered alphabetically by major.

GET /{program_code_list}

Tags: StdDownloadService

Returns a list of students in a program for the current year term. Ordered alphabetically by major.

program_code_list

string -> A '&' delimited list of 6 digit program codes. ie: 233160&355460&392160

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
{
"StdDownloadService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/232666/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"students": [
{
"address": "Address",
"email_address": "email@example.com",
"major": "Nursing",
"name": "Person, Name"
}
]
}
}
}
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 a list of students and their graduation status. Ordered alphabetically by program.

GET /{program_code_list}/{year_term}

Tags: StdDownloadService

Returns a list of students and their graduation status. Ordered alphabetically by program.

program_code_list

string -> A '&' delimited list of 6 digit program codes. ie: 233160&355460&392160

path string
year_term

yearTerm -> [1-2][0-9]{3}[1345]

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
{
"StdDownloadService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/232666/20175",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"gradSummary": [
{
"BYUid": "123456789",
"approved": "Yes",
"degree": "MACC",
"deptClearStatus": "C",
"name": "Student, Name",
"program": "Tax",
"thesisStatus": "WAIVED",
"universityClearStatus": "R"
}
]
}
}
}
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

address: string

approved: string

BYUid: string

degree: string

deptClearStatus: string

email_address: string

major: string

name: string

program: string

StdDownload: object

Student download for advisement logs.

StdDownloadService: object
request: StdDownRequest
response: StdDownResponse

StdDownRequest: 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.

StdDownResponse: object

students: object[]
object
name: name
address: address
email_address: email_address
major: major

StdTermDownload: object

StdDownloadService: object
request: StdDownRequest
response: StdTermDownResponse

StdTermDownResponse: object

gradSummary: object[]
object
BYUid: BYUid
name: name
program: program
degree: degree
approved: approved
thesisStatus: thesisStatus
deptClearStatus: deptClearStatus
universityClearStatus: universityClearStatus

thesisStatus: string

universityClearStatus: string

Service Path: 
/domains/legacy/academic/advisement/stddownload
Domain or University API: 
/domains/D/academic/advisement/stddownload

Community

 

Don't see your question listed here? Ask!