AcademicGradesGradeRollSelection

GradeSelectionService

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{year_term}/{person_id_net_id} GET

Returns course list for selected net ID.

/{year_term}/{teaching_area}/{catalog_number}/{section_number} GET

Returns course list for selected teaching area, catalog number and section number. You may leave any fields blank except for year term and any one of the other fields. To leave a field blank, enter a space as the input for fields you wish to leave blank.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Returns course list for selected net ID.

GET /{year_term}/{person_id_net_id}

Tags: GradeSelectionService

Returns course list for selected net ID.

year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string
person_id_net_id

string -> individual person identifier

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/20181/C S/142/001/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"Courses": [
{
"catalog_number": "142",
"course_description": "Intro to Computer Programming",
"curriculum_id": "01489",
"days": "MWF",
"enrolled": "103",
"instructor_id": "123456789",
"instructor_name": "Instructor, Name",
"section_number": "001",
"status": "Available on 04/18/2018",
"teaching_area": "C S",
"time": "1:00a - 11:50p",
"title_code": "002"
}
]
,
"NUM_RECS": "1",
"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.

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 course list for selected teaching area, catalog number and section number. You may leave any fields blank except for year term and any one of the other fields. To leave a field blank, enter a space as the input for fields you wish to leave blank.

GET /{year_term}/{teaching_area}/{catalog_number}/{section_number}

Tags: GradeSelectionService

Returns course list for selected teaching area, catalog number and section number. You may leave any fields blank except for year term and any one of the other fields. To leave a field blank, enter a space as the input for fields you wish to leave blank.

year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string
teaching_area

string -> 3-5 characters

path string
catalog_number

string -> 3 digit number

path string
section_number

string -> Must be 3 digit number. i.e. 001 for section one.

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/20181/C S/142/001/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"Courses": [
{
"catalog_number": "142",
"course_description": "Intro to Computer Programming",
"curriculum_id": "01489",
"days": "MWF",
"enrolled": "103",
"instructor_id": "123456789",
"instructor_name": "Instructor, Name",
"section_number": "001",
"status": "Available on 04/18/2018",
"teaching_area": "C S",
"time": "1:00a - 11:50p",
"title_code": "002"
}
]
,
"NUM_RECS": "1",
"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.

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

catalog_number: string

course_description: string

Courses: object[]

object
teaching_area: teaching_area
catalog_number: catalog_number
section_number: section_number
course_description: course_description
instructor_id: instructor_id
instructor_name: instructor_name
time: time
days: days
enrolled: enrolled
curriculum_id: curriculum_id
title_code: title_code
status: status

curriculum_id: string

days: string

enrolled: string

GradeSelectionService: object

request: request
response: response

instructor_id: string

instructor_name: string

NUM_RECS: string

request: object

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

response: object

NUM_RECS: NUM_RECS
year_term: year_term
Courses: Courses

section_number: string

status: string

teaching_area: string

time: string

title_code: string

year_term: string

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

Community

 

Don't see your question listed here? Ask!