AcademicRegistrationWaitlist
This service returns the wait list queue information for either a student or a course from the AIM System.
Base URL: /domains/legacy/academic/registration/waitlist
Version: 1.0.0
Summary
| Path | Operation | Description |
|---|---|---|
| /delete/{curriculum_id}/{title_code}/{section}/{year_term}/{person_id} | GET | Removes a student from the queue |
| /documentation | GET | service definition |
| /{curriculum_id}/{title_code}/{section}/{year_term} | GET | Returns the waitlist queue and/or log for a class. Detailed meta data will not be included if include_details is false. include_details will default to true if not included in the query string. include_logs will default to true if not included in the query string. include_queue will default to true if not included in the query string. |
| /{year_term}/{person_id} | GET | Returns a student from the queue. Detailed meta data will not be included if include_details is false. include_details will default to true if not included in the query string. include_logs will default to true if not included in the query string. include_queue will default to true if not included in the query string. |
Paths
GET /delete/{curriculum_id}/{title_code}/{section}/{year_term}/{person_id}
Tags: WaitlistQueueManagementServiceRemoves a student from the queue
| curriculum_id | string -> ##### | path | string | |
| title_code | string -> ### | path | string | |
| section | string -> ### | path | string | |
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| person_id | string -> ######### | path | string | |
| include_details | Returns information about the course itself as well as the queue and log sizes. (Defaults to true) | query | boolean | |
| include_queue | Returns the current queue of students waiting to add the class. (Defaults to true) | query | boolean | |
| include_logs | Returns the complete log of queue information. (Defaults to false) | query | boolean |
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.
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{curriculum_id}/{title_code}/{section}/{year_term}
Tags: WaitlistQueueManagementServiceReturns the waitlist queue and/or log for a class. Detailed meta data will not be included if include_details is false. include_details will default to true if not included in the query string. include_logs will default to true if not included in the query string. include_queue will default to true if not included in the query string.
| curriculum_id | string -> ##### | path | string | |
| title_code | string -> ### | path | string | |
| section | string -> ### | path | string | |
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| include_details | Returns information about the course itself as well as the queue and log sizes. (Defaults to true) | query | boolean | |
| include_queue | Returns the current queue of students waiting to add the class. (Defaults to true) | query | boolean | |
| include_logs | Returns the complete log of queue information. (Defaults to false) | query | boolean |
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": "/json/01489/002/002/20175/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"catalog_number": "142",
"catalog_suffix": "",
"combined_classes": [
],
"curriculum_id": "01489",
"department_name": "C S",
"log": [
],
"log_size": 0,
"queue": [
],
"queue_size": 0,
"section_number": "002",
"title_code": "002",
"transcript_title": "Intro to Computer Programming"
}
} - 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.
GET /{year_term}/{person_id}
Tags: WaitlistQueueManagementServiceReturns a student from the queue. Detailed meta data will not be included if include_details is false. include_details will default to true if not included in the query string. include_logs will default to true if not included in the query string. include_queue will default to true if not included in the query string.
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| person_id | string -> ######### | path | string | |
| include_details | Returns information about the course itself as well as the queue and log sizes. (Defaults to true) | query | boolean | |
| include_queue | Returns the current queue of students waiting to add the class. (Defaults to true) | query | boolean | |
| include_logs | Returns the complete log of queue information. (Defaults to false) | query | boolean |
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": "/json/20181/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"combined_classes": [
],
"curriculum_id": "",
"log": [
{
"action": "WL Insert",
"action_by_id": "123456789",
"action_by_name": "Name, Person",
"action_date": "2018-04-10T04:51:42",
"byu_id": "123456789",
"catalog_number": "428",
"catalog_suffix": "",
"class_standing": "Senior",
"credit_hours": 3,
"curriculum_id": "01512",
"department_name": "C S",
"email_address": "email",
"major_emphasis": "Computer Science",
"person_id": "123456789",
"position_in_log": 0,
"section_number": "001",
"sort_name": "Name, Person",
"title_code": "003",
"year_term": "20185"
}
],
"log_size": 0,
"queue": [
{
"add_error_message": "",
"added_by_id": "123456789",
"added_by_name": "Name, Person",
"byu_id": "123456789",
"catalog_number": "428",
"catalog_suffix": "",
"class_standing": "Senior",
"credit_hours": 3,
"curriculum_id": "01512",
"date_requested": "2018-04-10T04:51:42",
"department_name": "C S",
"email_address": "email",
"enrolled_section_number": "",
"error_timestamp": "",
"major_emphasis": "Computer Science",
"person_id": "123456789",
"position_in_queue": 6,
"section_number": "001",
"sort_name": "Name, Student",
"title_code": "003",
"year_term": "20185"
}
],
"queue_size": 0,
"section_number": "",
"title_code": ""
}
} - 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
- person_id: person_id
-
- position_in_log: position_in_log
-
- department_name: department_name
-
- catalog_number: catalog_number
-
- year_term: year_term
-
- curriculum_id: curriculum_id
-
- title_code: title_code
-
- catalog_suffix: catalog_suffix
-
- section_number: section_number
-
- credit_hours: credit_hours
-
- sort_name: sort_name
-
- byu_id: byu_id
-
- class_standing: class_standing
-
- major_emphasis: major_emphasis
-
- email_address: email_address
-
- action: action
-
- action_date: action_date
-
- action_by_id: action_by_id
-
- action_by_name: action_by_name
-
- person_id: person_id
-
- position_in_queue: position_in_queue
-
- department_name: department_name
-
- catalog_number: catalog_number
-
- catalog_suffix: catalog_suffix
-
- year_term: year_term
-
- curriculum_id: curriculum_id
-
- title_code: title_code
-
- enrolled_section_number: enrolled_section_number
-
- section_number: section_number
-
- credit_hours: credit_hours
-
- email_address: email_address
-
- sort_name: sort_name
-
- byu_id: byu_id
-
- class_standing: class_standing
-
- major_emphasis: major_emphasis
-
- date_requested: date_requested
-
- added_by_id: added_by_id
-
- added_by_name: added_by_name
-
- add_error_message: add_error_message
-
- error_timestamp: error_timestamp
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- department_name: department_name
-
- catalog_number: catalog_number
-
- catalog_suffix: catalog_suffix
-
- curriculum_id: curriculum_id
-
- transcript_title: transcript_title
-
- queue_size: queue_size
-
- log_size: log_size
-
- title_code: title_code
-
- section_number: section_number
-
- combined_classes: combined_classes
-
- queue: queue
-
- log: log
-
- curriculum_id: curriculum_id
-
- queue_size: queue_size
-
- log_size: log_size
-
- title_code: title_code
-
- section_number: section_number
-
- combined_classes: combined_classes
-
- queue: queue
-
- log: log
-
- request: request
-
- response: responsePerson
-
