AcademicRegistrationAIMRegistration
This service accesses registration information (including the current student schedule), adds classes, and drops classes in in the AIM System.
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/academic/registration/AIMregistration
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]Table of Contents
AIMRegistrationService
post /{person_id}/{year_term}%20*delete /delete/{person_id}/{year_term}*delete /delete/{person_id}/{year_term}/{curriculum_id}/{title_code}/{section}get /{person_id}/{year_term}%20*
Default
AIMRegistrationService
Up
post /{person_id}/{year_term}%20*Add registration information (addRegistrationInformation)
Add Registration Information
Path parameters
person_id (required)
Path Parameter x2014; individual person identifier
year_term (required)
Path Parameter x2014; The year and term
Query parameters
section (required)
Query Parameter x2014; 3 digit number. If not provided on DELETE, all classes will be dropped
curriculum_id (required)
Query Parameter x2014; 5 digit number
title_code (required)
Query Parameter x2014; 3 digit number
permission_code (optional)
Query Parameter x2014; Ignored if not applicable for the class
variable_credit_hours (optional)
Query Parameter x2014; Ignored if not applicable for the class
Return type
Example data
Content-Type: application/json
{ "request" : { "method" : "aeiou", "resource" : "aeiou", "attributes" : "aeiou", "statusMessage" : "aeiou", "status" : 1.3579000000000001069366817318950779736042022705078125 }, "response" : { "result" : "aeiou", "warning" : "aeiou", "successful" : "aeiou" }}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. postResponse400
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. ErrorResponse401
Failure to authenticate ErrorResponse403
The user does not have access to the resource. ErrorResponse404
The target resource can not be found for the provided resource identifiers. ErrorResponse405
The service method is not supported by the service. ErrorResponse409
A conflict has occurred. The response structure may contain information about the conflict. ErrorResponse500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. ErrorResponse Up
delete /delete/{person_id}/{year_term}*Drops all classes, but says it will only drop one (dropClass)
Drops all classes, but says it will only drop one
Path parameters
person_id (required)
Path Parameter x2014; individual person identifier
year_term (required)
Path Parameter x2014; The year and term
Query parameters
curriculum_id (optional)
Query Parameter x2014; Individual identifier of the curriculum
title_code (optional)
Query Parameter x2014; Title code of the class
section (optional)
Query Parameter x2014; Determines a specific section
Return type
Example data
Content-Type: application/json
{ "response" : { "drop_result" : [ "aeiou" ] }}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. delete400
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. String401
Failure to authenticate String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. ErrorResponse409
A conflict has occurred. The response structure may contain information about the conflict. ErrorResponse500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
delete /delete/{person_id}/{year_term}/{curriculum_id}/{title_code}/{section}Drop class (dropSpecificClass)
Drop class
Path parameters
person_id (required)
Path Parameter x2014; individual person identifier
year_term (required)
Path Parameter x2014; The year and term
curriculum_id (required)
Path Parameter x2014; Individual identifier of the curriculum
title_code (required)
Path Parameter x2014; Title code of the class
section (required)
Path Parameter x2014; Determines a specific section
Return type
Example data
Content-Type: application/json
{ "response" : { "drop_result" : [ "aeiou" ] }}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. delete400
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. String401
Failure to authenticate String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. ErrorResponse409
A conflict has occurred. The response structure may contain information about the conflict. ErrorResponse500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
get /{person_id}/{year_term}%20*Get Registration Information (getRegistrationInformation)
Get Registration Information
Path parameters
person_id (required)
Path Parameter x2014; individual person identifier
year_term (required)
Path Parameter x2014; The year and term
Return type
Example data
Content-Type: application/json
{ "request" : { "method" : "aeiou", "resource" : "aeiou", "attributes" : "aeiou", "statusMessage" : "aeiou", "status" : 1.3579000000000001069366817318950779736042022705078125 }, "response" : { "total_credit_hours" : 1.3579000000000001069366817318950779736042022705078125, "class_standing" : "aeiou", "can_discontinue" : true, "number_of_classes" : 1.3579000000000001069366817318950779736042022705078125, "MISSION_DEFERMENT_FLAG" : "aeiou", "year_term" : "aeiou", "year_term_first" : "aeiou", "holds_table" : "", "distance_education_status" : "aeiou", "term_acad_standing" : "aeiou", "reg_priority_date" : "aeiou", "credit_list_table" : [ { "description" : "aeiou", "gpa" : 1.3579000000000001069366817318950779736042022705078125, "total_hours" : 1.3579000000000001069366817318950779736042022705078125, "earned_hours" : 1.3579000000000001069366817318950779736042022705078125, "graded_hours" : 1.3579000000000001069366817318950779736042022705078125 } ], "class_table" : "", "date_today" : "aeiou", "before_school" : true, "display_year_term" : "aeiou", "curr_acad_standing" : "aeiou", "class_table_with_permission" : "", "email_address" : "aeiou", "year_term_list" : [ { "na" : "aeiou", "description" : "aeiou", "year_term" : "aeiou" } ], "reg_status" : "aeiou", "graduate_full_time_status" : "aeiou", "discontinuance_date" : "aeiou", "programs" : [ { "major_program_id" : "aeiou", "program_id" : "aeiou", "degree" : "aeiou", "name" : "aeiou", "type" : "aeiou" } ], "YEAR_TERM_DEFERMENT_MISSION_RETURN" : "aeiou", "reg_eligibility" : "aeiou", "year_term_last" : "aeiou" }}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. RegistrationService400
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. ErrorResponse401
Failure to authenticate ErrorResponse403
The user does not have access to the resource. ErrorResponse404
The target resource can not be found for the provided resource identifiers. ErrorResponse405
The service method is not supported by the service. ErrorResponse409
A conflict has occurred. The response structure may contain information about the conflict. ErrorResponse500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. ErrorResponseDefault
Up
get /documentationservice definition (getServiceDocumentation)
service definition
Return type
String
Example data
Content-Type: application/json
"aeiou"Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
Success StringModels
[ Jump to Methods ]Table of Contents
credit_list_tabledeleteDeleteResponseErrorResponseErrorResponse_responseerror_dataerrorspostResponsepostResponseDataprogramsRegistrationServicerequestresponseyear_term_list
credit_list_table - Up
earned_hours (optional)
description (optional)
gpa (optional)
graded_hours (optional)
total_hours (optional)
DeleteResponse - Up
drop_result (optional)
error_data - Up
message (optional)
httpStatusCode (optional)
name (optional)
code (optional)
request - Up
status (optional)
resource (optional)
method (optional)
attributes (optional)
statusMessage (optional)
response - Up
MISSION_DEFERMENT_FLAG (optional)
can_discontinue (optional)
year_term_list (optional)
total_credit_hours (optional)
graduate_full_time_status (optional)
discontinuance_date (optional)
date_today (optional)
holds_table (optional)
class_table (optional)
programs (optional)
reg_priority_date (optional)
reg_eligibility (optional)
credit_list_table (optional)
term_acad_standing (optional)
number_of_classes (optional)
reg_status (optional)
year_term (optional)
before_school (optional)
year_term_first (optional)
class_table_with_permission (optional)
distance_education_status (optional)
year_term_last (optional)
display_year_term (optional)
curr_acad_standing (optional)
YEAR_TERM_DEFERMENT_MISSION_RETURN (optional)
class_standing (optional)
email_address (optional)
Service Path:
/domains/legacy/academic/registration/AIMregistration
Domain or University API:
D
