AcademicClassScheduleClassRoom
This service accesses class room information in the AIM System.
Base URL: /domains/legacy/academic/classschedule/classroom
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/{year_term} | GET | Shows all buildings able to be searched |
/{year_term}/{building_code} | GET | Returns class rooms for a given building which are available for scheduling |
/{year_term}/{building_code}/{room_number}/{class_room_view} | GET | Returns the specified class room with information according to the tab option: Schedule, Characteristics, Assignments, Exams, Images |
Paths
Shows all buildings able to be searched
year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Returns a list of building names
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/20121",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"buildings": [
{
"building_name": "BNSN"
}
]
}
} - 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 /{year_term}/{building_code}
Tags: ClassRoomServiceReturns class rooms for a given building which are available for scheduling
year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
building_code | string -> | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Returns the list of class rooms available in a particular building for a particular year_term.
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/20121/BNSN",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"roomList": [
{
"room_desc": "INTRO. CHEMISTRY/CANNON",
"room_number": "C130"
}
]
}
} - 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 /{year_term}/{building_code}/{room_number}/{class_room_view}
Tags: ClassRoomServiceReturns the specified class room with information according to the tab option: Schedule, Characteristics, Assignments, Exams, Images
year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
building_code | string -> | path | string | |
room_number | string -> | path | string | |
class_room_view | string -> values: 'Schedule', 'Characteristics', 'Assignments', 'Exams', 'Images' | 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": "/20121/BNSN/C130/Exams",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"roomList": [
{
"building": "BNSN",
"capacity": 36,
"effective_year_term": "Fall 2011",
"expired_year_term": "Summer 2012",
"room_desc": "INTRO. CHEMISTRY/CANNON",
"room_number": "C130",
"scheduling_characteristics": [
{
"assign_to": "",
"catalog_number": "107",
"catalog_suffix": "",
"class_time": "9:00a - 10:50a",
"credit_hours": 1,
"days": "T",
"dept_name": "CHEM",
"end_date": "",
"honors": "",
"instructor_name": "Brown, Philip Ross",
"lab_quiz_section": "",
"sched_type": "C",
"section_size": 120,
"section_type": "",
"serv_learning": "",
"start_date": "",
"total_enr": 115
}
],
"scheduling_type": "Q",
"space_mgt_characteristics": [
{
"attribute_type": "Chalkboard",
"attribute_value": "12W"
}
]
}
]
}
} - 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
- building_name: building_name
-
- room_number: room_number
-
- building: building
-
- scheduling_type: scheduling_type
-
- room_desc: room_desc
-
- capacity: capacity
-
- effective_year_term: effective_year_term
-
- expired_year_term: expired_year_term
-
- scheduling_characteristics: scheduling_characteristics
-
- space_mgt_characteristics: object[]
-
object - attribute_type: attribute_type
-
- attribute_value: attribute_value
-
- roomList: classRoomA
-
- request: request
-
- response: classRoomResponse
-
- roomList: roomList
-
- request: request
-
- response: listClassRoomResponse
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- buildings: buildings
-
- room_number: room_number
-
- room_desc: room_desc
-
- dept_name: string
-
- catalog_number: string
-
- catalog_suffix: string
-
- lab_quiz_section: string
-
- honors: string
-
- serv_learning: string
-
- credit_hours: number
-
- section_type: string
-
- class_time: string
-
- days: string
-
- instructor_name: string
-
- section_size: number
-
- total_enr: number
-
- sched_type: string
-
- assign_to: string
-
- start_date: string
-
- end_date: string
-