AcademicAdvisementDepartmentListPage
This service accesses resources in the Department List portion of the AIM System.
Base URL: /domains/legacy/academic/advisement/departmentlistpage
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET | GET |
| /{deptName} | GET | GET |
Paths
Returns a list of department names
Uses default content-types: application/json application/xml
- 200 OK
-
A list of department names
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"classInfo": [
{
"deptname": "ACC",
"sort_name": "Accounting"
}
]
}
} - 400 Bad Request
-
Error in the composition of the service request.
- 401 Unauthorized
-
Failure to authenticate.
- 403 Forbidden
-
You do not have access to this resource.
- 404 Not Found
-
The target resource cannot 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 further information.
- 500 Internal Server Error
-
Server error occurred generating the response.
Returns an individual department name
| deptName | Individual name of department | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
An individual department
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/ACC",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"classInfo": [
{
"catnum": 200,
"deptname": "AAC",
"suffix": "",
"title": "Principles of Accounting"
}
]
}
} - 400 Bad Request
-
Error in the composition of the service request.
- 401 Unauthorized
-
Failure to authenticate.
- 403 Forbidden
-
You do not have access to this resource.
- 404 Not Found
-
The target resource cannot 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 further information.
- 500 Internal Server Error
-
Server error occurred generating the response.
Schema definitions
A list of classes within a specific department.
- request: DeptListPageRequest
-
- response: ClassListPageResponse
-
{
"classInfo": [
{
"catnum": 200,
"deptname": "AAC",
"suffix": "",
"title": "Principles of Accounting"
}
]
} - classInfo: object[]
-
object - deptname: string
-
Department name of class.
- catnum: number
-
- suffix: string
-
- title: string
-
Title and explanation of class.
{
"attributes": "",
"method": "GET",
"resource": "/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
} - method: string
-
REST method for request service.
- resource: string
-
A resource.
- attributes: string
-
- status: number
-
Returns status of a REST request to determine success.
- statusMessage: string
-
Explanation of return status of request.
{
"classInfo": [
{
"deptname": "ACC",
"sort_name": "Accounting"
}
]
} - classInfo: object[]
-
object - deptname: string
-
Department name of class.
- sort_name: string
-
Title of department.
A list of all departments.
- request: DeptListPageRequest
-
- response: DeptListPageResponse
-
