AcademicClassScheduleStudentExamSchedule
This service accesses student resources in the Scheduling portion of the AIM System including the Student Exam Schedule.
Base URL: /domains/legacy/academic/classschedule/studentexamschedule
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET | MAY NOT WORK Returns the student exam schedule for the current year term using the person id of the user logged in. |
| /documentation | GET | service definition |
| /{person_id_year_term} | GET | MAY NOT WORK Returns the student exam schedule for the current year term using the person id given OR for a given year term using the person id of the user logged in |
| /{person_id}/{year_term} | GET | MAY NOT WORK Returns the student exam schedule for a given year term using the person id given. |
Paths
GET /
Tags: StudentExamScheduleServiceMAY NOT WORK Returns the student exam schedule for the current year term using the person id of the user logged in.
Uses default content-types: application/json application/xml
- 200 OK
-
View a student exam schedule
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"schedule_table": [
{
"building": "",
"catalog_number": "131",
"class_period": "",
"credit_hours": "0.5",
"date_begins": "",
"date_ends": "",
"days": "",
"honors": "",
"is_term_header": "",
"lab_quiz": "",
"room": "",
"section": "001",
"section_type": "",
"service": "2",
"teaching_area": "STAC",
"term_header": "",
"title": "Golf, Beginning"
},
{
"building": "RB",
"catalog_number": "312",
"class_period": "3:00p - 6:00p",
"credit_hours": "3.0",
"date_begins": "20 Apr 2018",
"date_ends": "20 Apr 2018",
"days": "F",
"honors": "",
"is_term_header": "",
"lab_quiz": "",
"room": "271",
"section": "002",
"section_type": "",
"service": "S",
"teaching_area": "C S",
"term_header": "",
"title": "Algorithm Design & Analysis"
},
{
"building": "JKB",
"catalog_number": "324",
"class_period": "11:00a - 2:00p",
"credit_hours": "3.0",
"date_begins": "23 Apr 2018",
"date_ends": "23 Apr 2018",
"days": "M",
"honors": "",
"is_term_header": "",
"lab_quiz": "N",
"room": "2113",
"section": "001",
"section_type": "",
"service": "S",
"teaching_area": "C S",
"term_header": "",
"title": "Systems Programming"
}
],
"year_term": "20181"
}
} - 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.
- 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 /{person_id_year_term}
Tags: StudentExamScheduleServiceMAY NOT WORK Returns the student exam schedule for the current year term using the person id given OR for a given year term using the person id of the user logged in
| person_id_year_term | string -> | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
View a student exam schedule
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"schedule_table": [
{
"building": "",
"catalog_number": "131",
"class_period": "",
"credit_hours": "0.5",
"date_begins": "",
"date_ends": "",
"days": "",
"honors": "",
"is_term_header": "",
"lab_quiz": "",
"room": "",
"section": "001",
"section_type": "",
"service": "2",
"teaching_area": "STAC",
"term_header": "",
"title": "Golf, Beginning"
},
{
"building": "RB",
"catalog_number": "312",
"class_period": "3:00p - 6:00p",
"credit_hours": "3.0",
"date_begins": "20 Apr 2018",
"date_ends": "20 Apr 2018",
"days": "F",
"honors": "",
"is_term_header": "",
"lab_quiz": "",
"room": "271",
"section": "002",
"section_type": "",
"service": "S",
"teaching_area": "C S",
"term_header": "",
"title": "Algorithm Design & Analysis"
},
{
"building": "JKB",
"catalog_number": "324",
"class_period": "11:00a - 2:00p",
"credit_hours": "3.0",
"date_begins": "23 Apr 2018",
"date_ends": "23 Apr 2018",
"days": "M",
"honors": "",
"is_term_header": "",
"lab_quiz": "N",
"room": "2113",
"section": "001",
"section_type": "",
"service": "S",
"teaching_area": "C S",
"term_header": "",
"title": "Systems Programming"
}
],
"year_term": "20181"
}
} - 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.
- 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 /{person_id}/{year_term}
Tags: StudentExamScheduleServiceMAY NOT WORK Returns the student exam schedule for a given year term using the person id given.
| person_id | string -> | path | string | |
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
View a student exam schedule
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"schedule_table": [
{
"building": "",
"catalog_number": "131",
"class_period": "",
"credit_hours": "0.5",
"date_begins": "",
"date_ends": "",
"days": "",
"honors": "",
"is_term_header": "",
"lab_quiz": "",
"room": "",
"section": "001",
"section_type": "",
"service": "2",
"teaching_area": "STAC",
"term_header": "",
"title": "Golf, Beginning"
},
{
"building": "RB",
"catalog_number": "312",
"class_period": "3:00p - 6:00p",
"credit_hours": "3.0",
"date_begins": "20 Apr 2018",
"date_ends": "20 Apr 2018",
"days": "F",
"honors": "",
"is_term_header": "",
"lab_quiz": "",
"room": "271",
"section": "002",
"section_type": "",
"service": "S",
"teaching_area": "C S",
"term_header": "",
"title": "Algorithm Design & Analysis"
},
{
"building": "JKB",
"catalog_number": "324",
"class_period": "11:00a - 2:00p",
"credit_hours": "3.0",
"date_begins": "23 Apr 2018",
"date_ends": "23 Apr 2018",
"days": "M",
"honors": "",
"is_term_header": "",
"lab_quiz": "N",
"room": "2113",
"section": "001",
"section_type": "",
"service": "S",
"teaching_area": "C S",
"term_header": "",
"title": "Systems Programming"
}
],
"year_term": "20181"
}
} - 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.
- 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
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- year_term: year_term
-
- schedule_table: schedule_table
-
- is_term_header: is_term_header
-
- term_header: term_header
-
- teaching_area: teaching_area
-
- catalog_number: catalog_number
-
- section: section
-
- lab_quiz: lab_quiz
-
- honors: honors
-
- service: service
-
- section_type: section_type
-
- class_period: class_period
-
- days: days
-
- date_begins: date_begins
-
- date_ends: date_ends
-
- room: room
-
- building: building
-
- title: title
-
- credit_hours: credit_hours
-
