AcademicRegistrationStudentLog
This service returns the registration log (adds and drops) for a student in a particular year_term from the AIM System.
Base URL: /domains/legacy/academic/registration/studentlog
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /LOGID/{std_class_log_id} | GET | Get the students class log identified by the std class log id. |
| /{person_id}/{year_term} | GET | Get the students class log identified by the given person id and year term. |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /LOGID/{std_class_log_id}
Tags: StudentLogServiceGet the students class log identified by the std class log id.
| std_class_log_id | Identification of the student's class log | path | string | |
| page | An integer for the page number | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for applications/json{
"request": {
"attributes": "page=1",
"method": "GET",
"resource": "/123456789/20181",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"add_drop_records": [
{
"action": "Add Failed",
"add_drop_card": "N",
"block": "S",
"clean_note": "",
"course_name": "REL C 471",
"credit_hours": 2,
"curriculum_id": "05074",
"date_time_updated": "2018-03-16T21:44:24",
"event_source": "",
"failure_reasons": [
{
"failure_reason_code": "9",
"reason": "Winter 2018 registration is not available at this time for this class. It is open from 23 Oct 2017 to 16 Jan 2018."
},
{
"failure_reason_code": "35",
"reason": "It is past the deadline for REL C 471 Section 002. For questions contact Registration at (801) 422-2631."
}
],
"grade": 3.7,
"lab_quiz_section": "",
"logId": "130305785",
"person_id": "123456789",
"section_number": "002",
"section_type": "",
"success": "N",
"title_code": "006",
"updated_by_name": "",
"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.
- 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 /{person_id}/{year_term}
Tags: StudentLogServiceGet the students class log identified by the given person id and year term.
| person_id | string -> nine digit number | path | string | |
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| page | An integer for the page number | query | string | |
| show_failed | show failed flag 'Y' or 'N' | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for applications/json{
"request": {
"attributes": "page=1",
"method": "GET",
"resource": "/123456789/20181",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"add_drop_records": [
{
"action": "Add Failed",
"add_drop_card": "N",
"block": "S",
"clean_note": "",
"course_name": "REL C 471",
"credit_hours": 2,
"curriculum_id": "05074",
"date_time_updated": "2018-03-16T21:44:24",
"event_source": "",
"failure_reasons": [
{
"failure_reason_code": "9",
"reason": "Winter 2018 registration is not available at this time for this class. It is open from 23 Oct 2017 to 16 Jan 2018."
},
{
"failure_reason_code": "35",
"reason": "It is past the deadline for REL C 471 Section 002. For questions contact Registration at (801) 422-2631."
}
],
"grade": 3.7,
"lab_quiz_section": "",
"logId": "130305785",
"person_id": "123456789",
"section_number": "002",
"section_type": "",
"success": "N",
"title_code": "006",
"updated_by_name": "",
"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.
- 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
- failure_reason_code: failure_reason_code
-
- reason: reason
-
- section_number: section_number
-
- person_id: person_id
-
- section_type: section_type
-
- logId: logId
-
- add_drop_card: add_drop_card
-
- date_time_updated: date_time_updated
-
- course_name: course_name
-
- clean_note: clean_note
-
- block: block
-
- year_term: year_term
-
- credit_hours: credit_hours
-
- title_code: title_code
-
- action: action
-
- curriculum_id: curriculum_id
-
- lab_quiz_section: lab_quiz_section
-
- grade: grade
-
- success: success
-
- updated_by_name: updated_by_name
-
- event_source: event_source
-
- failure_reasons: failure_reasons
-
- status: status
-
- resource: resource
-
- method: method
-
- attributes: attributes
-
- statusMessage: statusMessage
-
- add_drop_records: add_drop_records
-
