AcademicCurriculumAcademicUnit
This service allows for maintenance of the Academic Units. It allows the viewing of current information.
Base URL: /domains/legacy/academic/curriculum/academicunit
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /delete/{academic_unit_id} | GET | Delete Academic Unit |
| /delete{academic_unit_id}/{effective_date} | GET | Deletes an academic unit version specified by the effective date. |
| /documentation | GET | service definition |
| /{academic_unit_id} | GET | Get academic unit OR add academic unit |
| /{academic_unit_id}/{effective_date}/{tab_option} | GET | Returns back the latest academic unit that is before the effective date with a sub list determined by the tab option. |
| /{academic_unit_id}/{options} | GET | Get academic unit options |
Paths
Delete Academic Unit
| academic_unit_id | string -> | path | string |
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.
- 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 /delete{academic_unit_id}/{effective_date}
Tags: AcademicUnitServiceDeletes an academic unit version specified by the effective date.
| academic_unit_id | string -> | path | string | |
| effective_date | date -> dd Mon yyyy | path | string |
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.
- 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
Returns back the current department associated with the academic unit
| academic_unit_id | string -> | path | string | |
| unit_name | Name of the unit | query | string | |
| official_name | Official name of the academic unit | query | string | |
| effective_date | Date it becomes effective-DD MM YYYY | query | string | |
| expired_date | Date it becomes expired DD MM YYYY | query | string | |
| unit_type | Designates the unit type | query | string | |
| unit_level_desc | Shows the unit level in descending order | query | string | |
| unit_level | Shows the unit level | query | string | |
| old_unit_id | shows what unit ID used to be | query | string | |
| parent_unit_id | Shows the parent unit ID | query | 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": "/1112",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"academic_unit": {
"academic_unit_id": "1112",
"credit_institution": "BYU PROVO",
"effective_date": "1990-09-04",
"expired_date": "1997-09-01",
"official_name": "Instructional Science",
"old_unit_id": "1112",
"parent_unit_id": "1008",
"parent_unit_level": "College Level",
"parent_unit_level_number": "2",
"parent_unit_type": "COLLEGE",
"unit_level_number": "3",
"unit_name": "Instructional Science",
"unit_type": "DEPARTMENT"
}
}
} - 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 /{academic_unit_id}/{effective_date}/{tab_option}
Tags: AcademicUnitServiceReturns back the latest academic unit that is before the effective date with a sub list determined by the tab option.
| academic_unit_id | string -> | path | string | |
| effective_date | date -> dd Mon yyyy | path | string | |
| tab_option | string -> [contacts|history|teaching_areas|sub_units|programs] | 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": "/1112/contacts",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"academic_unit": {
"academic_unit_id": "1112",
"credit_institution": "BYU PROVO",
"effective_date": "1990-09-04",
"expired_date": "1997-09-01",
"official_name": "Instructional Science",
"old_unit_id": "1112",
"parent_unit_id": "1008",
"parent_unit_level": "College Level",
"parent_unit_level_number": "2",
"parent_unit_type": "COLLEGE",
"unit_level_number": "3",
"unit_name": "Instructional Science",
"unit_type": "DEPARTMENT"
},
"contacts": [
]
}
} - 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 academic unit options
| academic_unit_id | string -> | path | string | |
| options | string -> [contacts|history|teaching_areas|sub_units|programs] | path | string | |
| unit_name | Name of the unit | query | string | |
| official_name | Official name of the academic unit | query | string | |
| effective_date | Date it becomes effective-DD MM YYYY | query | string | |
| expired_date | Date it becomes expired DD MM YYYY | query | string | |
| unit_type | Designates the unit type | query | string | |
| unit_level_desc | Shows the unit level in descending order | query | string | |
| unit_level | Shows the unit level | query | string | |
| old_unit_id | shows what unit ID used to be | query | string | |
| parent_unit_id | Shows the parent unit ID | query | 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": "/1112/contacts",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"academic_unit": {
"academic_unit_id": "1112",
"credit_institution": "BYU PROVO",
"effective_date": "1990-09-04",
"expired_date": "1997-09-01",
"official_name": "Instructional Science",
"old_unit_id": "1112",
"parent_unit_id": "1008",
"parent_unit_level": "College Level",
"parent_unit_level_number": "2",
"parent_unit_type": "COLLEGE",
"unit_level_number": "3",
"unit_name": "Instructional Science",
"unit_type": "DEPARTMENT"
},
"contacts": [
]
}
} - 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
- academic_unit_id: academic_unit_id
-
- unit_name: unit_name
-
- effective_date: effective_date
-
- expired_date: expired_date
-
- official_name: official_name
-
- unit_type: unit_type
-
- unit_level_number: unit_level_number
-
- old_unit_id: old_unit_id
-
- credit_institution: credit_institution
-
- parent_unit_type: parent_unit_type
-
- parent_unit_level: parent_unit_level
-
- parent_unit_id: parent_unit_id
-
- parent_unit_level_number: parent_unit_level_number
-
- request: request
-
- response: responseOptions
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- academic_unit: academic_unit
-
- academic_unit: academic_unit
-
- contacts: object[]
-
object - versions: object[]
-
object - teaching_areas: object[]
-
object - sub_units: object[]
-
object - programs: object[]
-
object
