AcademicGradesGradeRollMonitor
This service accesses resources in the Grade Roll Monitor portion of the AIM System.
Base URL: /domains/legacy/academic/grades/graderollmonitor
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{year_term} | GET | Returns list of academic units and their grade roll submission info. |
| /{year_term}/{academic_unit_id_dept_name} | GET | Returns grade roll submission info for given year term, academic unit, and department name. |
| /{year_term}/{dept_name}/{catalog_number_person_id_net_id}/{section_number} | GET | Selects specific teaching area records based off of catalog number and section number |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{year_term}
Tags: GradeRollMonitorServiceReturns list of academic units and their grade roll submission info.
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | 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/20175/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Current": [
{
"official_name": "BYU Provo",
"rolls_not_submitted": "0",
"rolls_percent": "100.00",
"rolls_submitted": "6337",
"std_not_submitted": "0",
"std_percent": "100.00",
"std_submitted": "174755"
}
],
"Selected": [
],
"Units": [
{
"academic_unit_id": "1019",
"official_name": "Religious Education",
"rolls_not_submitted": "0",
"rolls_percent": "100.00",
"rolls_submitted": "331",
"std_not_submitted": "0",
"std_percent": "100.00",
"std_submitted": "21154"
}
],
"auths": "User Level:U User Type:2 Academic Unit ID:1000 Description:DAYEVE University User Level:U User Type:4 Academic Unit ID:1000 Description:OTHER University",
"classes": [
]
}
} - 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.
- 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 /{year_term}/{academic_unit_id_dept_name}
Tags: GradeRollMonitorServiceReturns grade roll submission info for given year term, academic unit, and department name.
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| academic_unit_id_dept_name | 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/20175/1019",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Current": [
{
"official_name": "Religious Education",
"rolls_not_submitted": "0",
"rolls_percent": "100.00",
"rolls_submitted": "331",
"std_not_submitted": "0",
"std_percent": "100.00",
"std_submitted": "21154"
}
],
"Selected": [
],
"Units": [
{
"academic_unit_id": "1389",
"official_name": "Ancient Scripture, Department of",
"rolls_not_submitted": "0",
"rolls_percent": "100.00",
"rolls_submitted": "156",
"std_not_submitted": "0",
"std_percent": "100.00",
"std_submitted": "10613"
}
],
"auths": "User Level:U User Type:2 Academic Unit ID:1000 Description:DAYEVE University User Level:U User Type:4 Academic Unit ID:1000 Description:OTHER University",
"classes": [
],
"depts": [
{
"dept_and_sort": "REL E (Rel E - Religious Education)",
"dept_name": "REL E",
"rolls_not_submitted": "0",
"rolls_percent": "100.00",
"rolls_submitted": "7",
"sort_name": "Rel E - Religious Education",
"std_not_submitted": "0",
"std_percent": "100.00",
"std_submitted": "49"
}
]
}
} - 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.
- 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 /{year_term}/{dept_name}/{catalog_number_person_id_net_id}/{section_number}
Tags: GradeRollMonitorServiceSelects specific teaching area records based off of catalog number and section number
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| dept_name | string -> | path | string | |
| catalog_number_person_id_net_id | string -> | path | string | |
| section_number | 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/20175/REL E/600/001",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Current": [
{
"official_name": "Rel E - Religious Education",
"rolls_not_submitted": "0",
"rolls_percent": "100.00",
"rolls_submitted": "7",
"std_not_submitted": "0",
"std_percent": "100.00",
"std_submitted": "49"
}
],
"Selected": [
{
"rolls_not_submitted": "0",
"rolls_percent": "100.00",
"rolls_submitted": "2",
"sort_name": "Rel E - Religious Education (Selected)",
"std_not_submitted": "0",
"std_percent": "100.00",
"std_submitted": "8"
}
],
"auths": "User Level:U User Type:2 Academic Unit ID:1000 Description:DAYEVE University User Level:U User Type:4 Academic Unit ID:1000 Description:OTHER University",
"classes": [
{
"catalog": "600",
"course_days": "M",
"course_time": "1:00a - 11:30p",
"curriculum_id": "12253",
"dept_name": "REL E",
"instructor_id": "123456789",
"instructor_name": "Instructor, Name",
"section_number": "001",
"section_number2": "001",
"selected_name": "",
"status": "Posted on01/03/2018",
"title_code": "000",
"total_enrolled": "4",
"transcript_title": "Pastoral Ministry",
"year_term": "20175"
}
]
}
} - 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.
- 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
- selected_name: selected_name
-
- dept_name: dept_name
-
- catalog: catalog
-
- section_number: section_number
-
- transcript_title: transcript_title
-
- instructor_id: instructor_id
-
- instructor_name: instructor_name
-
- course_time: course_time
-
- course_days: course_days
-
- total_enrolled: total_enrolled
-
- status: status
-
- curriculum_id: curriculum_id
-
- title_code: title_code
-
- section_number2: section_number2
-
- year_term: year_term
-
- official_name: official_name
-
- rolls_not_submitted: rolls_not_submitted
-
- rolls_submitted: rolls_submitted
-
- rolls_percent: rolls_percent
-
- std_not_submitted: std_not_submitted
-
- std_submitted: std_submitted
-
- std_percent: std_percent
-
- dept_name: dept_name
-
- sort_name: sort_name
-
- dept_and_sort: dept_and_sort
-
- rolls_not_submitted: rolls_not_submitted
-
- rolls_submitted: rolls_submitted
-
- rolls_percent: rolls_percent
-
- std_not_submitted: std_not_submitted
-
- std_submitted: std_submitted
-
- std_percent: std_percent
-
- request: request
-
- response: responseAcadID
-
- request: request
-
- response: responseDeptName
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- sort_name: sort_name
-
- rolls_not_submitted: rolls_not_submitted
-
- rolls_submitted: rolls_submitted
-
- rolls_percent: rolls_percent
-
- std_not_submitted: std_not_submitted
-
- std_submitted: std_submitted
-
- std_percent: std_percent
-
- academic_unit_id: academic_unit_id
-
- official_name: official_name
-
- rolls_not_submitted: rolls_not_submitted
-
- rolls_submitted: rolls_submitted
-
- rolls_percent: rolls_percent
-
- std_not_submitted: std_not_submitted
-
- std_submitted: std_submitted
-
- std_percent: std_percent
-
