AcademicRegistrationEligibility

This service returns the registration eligibility for a student in the AIM System.

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

Base URL: /domains/legacy/academic/registration/eligibility

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id} GET

Get the registration status for the specified person.

/{person_id}?* DELETE

Delete Eligibilities

POST

Add Eligibilities

PUT

Update Eligibilities

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Get the registration status for the specified person.

GET /{person_id}

Tags: EligibilityService

Get the registration status for the specified person.

person_id

string ->

path string

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

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"deferment_data": "",
"has_deferment": "N",
"year_terms": [
{
"degree": "",
"num_classes": 0,
"reg_eligibility": "DC",
"reg_status": "9",
"term2_admit": "",
"withdrawal_date": "",
"year_term": 20185
},
{
"degree": "",
"num_classes": 1,
"reg_eligibility": "DC",
"reg_status": "9",
"term2_admit": "",
"withdrawal_date": "",
"year_term": 20183
},
{
"degree": "",
"num_classes": 5,
"reg_eligibility": "DC",
"reg_status": "9",
"term2_admit": "",
"withdrawal_date": "",
"year_term": 20181
},
{
"degree": "",
"num_classes": 5,
"reg_eligibility": "DC",
"reg_status": "9",
"term2_admit": "",
"withdrawal_date": "",
"year_term": 20175
},
{
"degree": "",
"num_classes": 6,
"reg_eligibility": "DC",
"reg_status": "9",
"term2_admit": "",
"withdrawal_date": "",
"year_term": 20171
},
{
"degree": "",
"num_classes": 5,
"reg_eligibility": "DC",
"reg_status": "8",
"term2_admit": "",
"withdrawal_date": "",
"year_term": 20165
}
]
}
}
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.

Delete Eligibilities

DELETE /{person_id}?*

Tags: EligibilityService

Delete Eligibilities

person_id

The Person ID of the resource

path string
elig_action

Indicates the action (add, del, upd)

query string
numTerms

Specify the number of semesters provided in the request

query string
yearterm

The year term of the eligibility to be deleted

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.

403 Forbidden

The user does not have access to the resource.

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.

Add Eligibilities

POST /{person_id}?*

Tags: EligibilityService

Add Eligibilities

person_id

The Person ID of the resource

path string
elig_action

Indicates the action (add, del, upd)

query string
numTerms

Specify the number of semesters provided in the request

query string
yearterm

The year term of the eligibility to be added

query string
regstatus

The reg status to be added

query string
regeligibility

The reg eligibility to be added

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.

403 Forbidden

The user does not have access to the resource.

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.

Update Eligibilities

PUT /{person_id}?*

Tags: EligibilityService

Update Eligibilities

person_id

The Person ID of the resource

path string
elig_action

Indicates the action (add, del, upd)

query string
numTerms

Specify the number of semesters provided in the request

query string
yearterm

The year term of the eligibility to be updated

query string
regstatus

The reg status to be updated

query string
regeligibility

The reg eligibility to be updated

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.

403 Forbidden

The user does not have access to the resource.

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

error_data: object

message: string
httpStatusCode: number
name: string
code: string

ErrorResponse: object

response: object
errors: errors
request: request

errors: object[]

RegStdTermStatusService: object

response: object
has_deferment: string
year_terms: object[]
object
reg_eligibility: string
degree: string
withdrawal_date: string
term2_admit: string
reg_status: string
year_term: number
num_classes: number
deferment_data: string
request: request

RegStdTermStatusServiceChange: object

response: object
request: request

request: object

status: number
resource: string
method: string
attributes: string
statusMessage: string
Service Path: 
/domains/legacy/academic/registration/eligibility
Domain or University API: 
/domains/D/academic/registration/eligibility

Community

 

Don't see your question listed here? Ask!