AcademicGradesGradeRollMonitor

This service accesses resources in the Grade Roll Monitor portion of the AIM System.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/academic/grades/graderollmonitor

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

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

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Returns list of academic units and their grade roll submission info.

GET /{year_term}

Tags: GradeRollMonitorService

Returns 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.

Returns grade roll submission info for given year term, academic unit, and department name.

GET /{year_term}/{academic_unit_id_dept_name}

Tags: GradeRollMonitorService

Returns 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.

Selects specific teaching area records based off of catalog number and section number

GET /{year_term}/{dept_name}/{catalog_number_person_id_net_id}/{section_number}

Tags: GradeRollMonitorService

Selects 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

academic_unit_id: string

auths: string

catalog: string

classes: object[]

object
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

course_days: string

course_time: string

Current: object[]

object
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

curriculum_id: string

dept_and_sort: string

dept_name: string

depts: object[]

object
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

GradeRollMonitorService: object

request: request
response: response

GradeRollMonitorServiceAcadID: object

request: request
response: responseAcadID

GradeRollMonitorServiceDeptName: object

request: request
response: responseDeptName

instructor_id: string

instructor_name: string

official_name: string

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

response: object

auths: auths
Current: Current
Selected: Selected
Units: Units
classes: classes

responseAcadID: object

auths: auths
Current: Current
Selected: Selected
Units: Units
depts: depts
classes: classes

responseDeptName: object

auths: auths
Current: Current
Selected: Selected
classes: classes

rolls_not_submitted: string

rolls_percent: string

rolls_submitted: string

section_number: string

section_number2: string

Selected: object[]

object
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

selected_name: string

sort_name: string

status: string

std_not_submitted: string

std_percent: string

std_submitted: string

title_code: string

total_enrolled: string

transcript_title: string

Units: object[]

object
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

year_term: string

Service Path: 
/domains/legacy/academic/grades/graderollmonitor
Domain or University API: 
/domains/D/academic/grades/graderollmonitor

Community

 

Don't see your question listed here? Ask!