AcademicTransferTranClassEquiv
This service returns list of departments for selected college, returns list of catalog numbers for selected department, and returns course equivalent for selected course. This information is gathered from the class scheduling and registration components of the AIM System.
Base URL: /domains/legacy/academic/transfer/tranclassequiv
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/documentation | GET | service definition |
/{collegeCode}/{university} | GET | Returns list of departments for selected college. |
/{collegeCode}/{university}/{department} | GET | Returns list of catalog numbers for selected department. |
/{collegeCode}/{university}/{department}/{catalogNumber} | GET | Returns course equivalent for selected course. |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{collegeCode}/{university}
Tags: TranClassEquivServiceReturns list of departments for selected college.
collegeCode | string -> 5 digit number. | path | string | |
university | string -> [BYU|OTH] BYU if entering byu department, or OTH if entering department for other university. | 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": "/json/99999/BYU/C S/199/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Btrn_catalog_number": "",
"Btrn_dept_name": "",
"active_status": "Active",
"byuCourseList": [
],
"byuDeptList": [
{
"dept": "C S",
"selected": "selected"
}
],
"byu_catalog_number": "199",
"byu_dept_name": "C S",
"byu_description": "Academic Internship",
"byu_expired_date": "31 Dec 2999",
"college_city": "PROVO",
"college_code": "99999",
"college_name": "BRIGHAM YOUNG UNIVERSITY",
"college_state": "UT",
"courseList": [
{
"course": "199",
"selected": "selected"
}
],
"course_description": "",
"expired_year_term": "- Expired May not Transfer",
"trnClassEvalList": [
],
"trnCollegeDeptList": [
]
}
} - 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 /{collegeCode}/{university}/{department}
Tags: TranClassEquivServiceReturns list of catalog numbers for selected department.
collegeCode | string -> 5 digit number. | path | string | |
university | string -> [BYU|OTH] BYU if entering byu department, or OTH if entering department for other university. | path | string | |
department | string -> Department name. | 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": "/json/99999/BYU/C S/199/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Btrn_catalog_number": "",
"Btrn_dept_name": "",
"active_status": "Active",
"byuCourseList": [
],
"byuDeptList": [
{
"dept": "C S",
"selected": "selected"
}
],
"byu_catalog_number": "199",
"byu_dept_name": "C S",
"byu_description": "Academic Internship",
"byu_expired_date": "31 Dec 2999",
"college_city": "PROVO",
"college_code": "99999",
"college_name": "BRIGHAM YOUNG UNIVERSITY",
"college_state": "UT",
"courseList": [
{
"course": "199",
"selected": "selected"
}
],
"course_description": "",
"expired_year_term": "- Expired May not Transfer",
"trnClassEvalList": [
],
"trnCollegeDeptList": [
]
}
} - 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 /{collegeCode}/{university}/{department}/{catalogNumber}
Tags: TranClassEquivServiceReturns course equivalent for selected course.
collegeCode | string -> 5 digit number. | path | string | |
university | string -> [BYU|OTH] BYU if entering byu department, or OTH if entering department for other university. | path | string | |
department | string -> Department name. | path | string | |
catalogNumber | string -> | 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": "/json/99999/BYU/C S/199/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Btrn_catalog_number": "",
"Btrn_dept_name": "",
"active_status": "Active",
"byuCourseList": [
],
"byuDeptList": [
{
"dept": "C S",
"selected": "selected"
}
],
"byu_catalog_number": "199",
"byu_dept_name": "C S",
"byu_description": "Academic Internship",
"byu_expired_date": "31 Dec 2999",
"college_city": "PROVO",
"college_code": "99999",
"college_name": "BRIGHAM YOUNG UNIVERSITY",
"college_state": "UT",
"courseList": [
{
"course": "199",
"selected": "selected"
}
],
"course_description": "",
"expired_year_term": "- Expired May not Transfer",
"trnClassEvalList": [
],
"trnCollegeDeptList": [
]
}
} - 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
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- college_code: college_code
-
- college_name: college_name
-
- college_city: college_city
-
- college_state: college_state
-
- active_status: active_status
-
- trnCollegeDeptList: trnCollegeDeptList
-
- courseList: courseList
-
- Btrn_dept_name: Btrn_dept_name
-
- Btrn_catalog_number: Btrn_catalog_number
-
- course_description: course_description
-
- expired_year_term: expired_year_term
-
- byuCourseList: byuCourseList
-
- byuDeptList: byuDeptList
-
- byu_dept_name: byu_dept_name
-
- byu_catalog_number: byu_catalog_number
-
- byu_description: byu_description
-
- byu_expired_date: byu_expired_date
-
- trnClassEvalList: trnClassEvalList
-