AcademicAdvisementGradClearance

This service accesses a graduation clearance screen for the person identified.

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

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

Version: v1

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

Summary

Path Operation Description
/{person_id} GET

Returns the Grad Clearance page for the person identified

/{person_id}/{year_term} DELETE

NOT COMPLETED: Delete a class for the specified person id for the specified year term.

PUT

NOT COMPLETED: Add a class for the specified person id for the specified year term.

Paths

Returns the Grad Clearance page for the person identified

GET /{person_id}

Tags: GradClearanceService

Returns the Grad Clearance page for the person identified

person_id

string -> 9 digit number. [0-9]{9}

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": "/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"acadStanding": "GOOD",
"address": [
"3217 ITB"
]
,
"credits": [
{
"GPA": "3.28",
"creditsFrom": "BYU",
"hrsEarned": "210.00",
"hrsGraded": "199.50",
"points": "654.25"
}
]
,
"currentName": "Student, Joseph",
"dataTable": [
]
,
"editFlag": "Yes",
"geTable": [
]
,
"gradMessage": "",
"gradYearTerm": "",
"holds": "Yes",
"name": "Student, Joseph",
"otherDataTable": [
{
"academicUnit": "DEPARTMENT:Elementary Education",
"code": "354418",
"effYrt": "19965",
"primary": "Y",
"programName": "Elementary Education",
"teach": "B",
"type": "MAJOR"
}
]
,
"phiKappaPhi": "N",
"prevNames": [
{
"prevName": "Student, Joe"
}
]
}
}
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.

NOT COMPLETED: Delete a class for the specified person id for the specified year term.

DELETE /{person_id}/{year_term}

Tags: GradClearanceService

NOT COMPLETED: Delete a class for the specified person id for the specified year term.

person_id

string -> 9 digit number. [0-9]{9}

path string
year_term

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

path string
section

3 digit number. If not provided on DELETE, all classes will be dropped

query string
curriculum_id

5 digit number

query string
title_code

3 digit number

query string

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

200 OK

Service request is OK and a response has been generated.

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.

NOT COMPLETED: Add a class for the specified person id for the specified year term.

PUT /{person_id}/{year_term}

Tags: GradClearanceService

NOT COMPLETED: Add a class for the specified person id for the specified year term.

person_id

string -> 9 digit number. [0-9]{9}

path string
year_term

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

path string
section

3 digit number. If not provided on DELETE, all classes will be dropped

query string
curriculum_id

5 digit number

query string
title_code

3 digit number

query string

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

200 OK

Service request is OK and a response has been generated.

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

academicUnit: string

acadStanding: string

address: string[]

string

code: string

credits: object[]

object
creditsFrom: creditsFrom
hrsEarned: hrsEarned
hrsGraded: hrsGraded
points: points
GPA: GPA

creditsFrom: string

currentName: string

dataTable: string[]

string

editFlag: string

effYrt: string

geTable: string[]

string

GPA: string

GradClearanceService: object

request: request
response: response

gradMessage: string

gradYearTerm: string

holds: string

hrsEarned: string

hrsGraded: string

name: string

otherDataTable: object[]

object
primary: primary
teach: teach
code: code
effYrt: effYrt
type: type
programName: programName
academicUnit: academicUnit

phiKappaPhi: string

points: string

prevName: string

prevNames: object[]

object
prevName: prevName

primary: string

programName: string

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

response: object

gradMessage: gradMessage
name: name
address: address
currentName: currentName
prevNames: prevNames
phiKappaPhi: phiKappaPhi
editFlag: editFlag
acadStanding: acadStanding
holds: holds
credits: credits
gradYearTerm: gradYearTerm
geTable: geTable
dataTable: dataTable
otherDataTable: otherDataTable

teach: string

type: string

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

Community

 

Don't see your question listed here? Ask!