AcademicGradesGradeNote

This service accesses the classes for which the student has registered for a given term.

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{credit_institution}/{year_term}/{curriculum_id}/{title_code}/{section_number} GET

get a grade note for a given class given the credit institution, year term, curriculum id, title code, and section number

PUT

Adds process notes

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

get a grade note for a given class given the credit institution, year term, curriculum id, title code, and section number

GET /{credit_institution}/{year_term}/{curriculum_id}/{title_code}/{section_number}

Tags: GradeNoteService

get a grade note for a given class given the credit institution, year term, curriculum id, title code, and section number

credit_institution

string ->

path string
year_term

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

path string
curriculum_id

string -> 5 digit number.

path string
title_code

string -> 3 digit number.

path string
section_number

string -> 3 digit number.

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
{
"GradeNoteService": {
"request": {
"attributes": null,
"method": "GET",
"resource": "/BYU PROVO/20175/01489/002/002",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"beginDate": "2017-09-05",
"cat": "142",
"comment": null,
"courseDescription": "Intro to Computer Programming",
"dateUpdated": "JANUARY 03, 2018, 11:12:44 A.M.",
"datesSaved": null,
"days": "MWF",
"daysLeft": "-37",
"dept": "C S",
"dueTime": "Noon",
"endDate": "2017-12-14",
"gradesDue": "2018-01-03",
"hoursLeft": "-1",
"instructor": "Teacher, Professor",
"lastChange": "Posted",
"note": null,
"savedBy": null,
"sec": "002",
"time": "2:00 - 2:50p",
"updatedBy": "Person, Name",
"validGrades": "A B C D E I P T",
"whenSaved": null,
"whoSaved": null
}
}
}
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.

Adds process notes

PUT /{credit_institution}/{year_term}/{curriculum_id}/{title_code}/{section_number}

Tags: GradeNoteService

Adds process notes

Saves a grade note

credit_institution

string ->

path string
year_term

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

path string
curriculum_id

string -> 5 digit number.

path string
title_code

string -> 3 digit number.

path string
section_number

string -> 3 digit number.

path string
note

This can be any type of comment you would like to include under notes

query string
processnote

Any type of comment to include under process notes

query string
ClearProcessNote

Set value isChecked to mark note as cleared. Otherwise put nothing

query string

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

200 OK

Service request is OK and a response has been generated.

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

beginDate: string,null

cat: string,null

comment: string,null

courseDescription: string,null

datesSaved: string,null

dateUpdated: string,null

days: string,null

daysLeft: string,null

dept: string,null

dueTime: string,null

endDate: string,null

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

GradeNoteService: object

GradeNoteService: object
request: request
response: response

gradesDue: string,null

hoursLeft: string,null

instructor: string,null

lastChange: string,null

note: string,null

request: object

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

response: object

beginDate: beginDate
endDate: endDate
gradesDue: gradesDue
dueTime: dueTime
daysLeft: daysLeft
hoursLeft: hoursLeft
dept: dept
cat: cat
sec: sec
courseDescription: courseDescription
instructor: instructor
time: time
days: days
validGrades: validGrades
lastChange: lastChange
dateUpdated: dateUpdated
updatedBy: updatedBy
note: note
savedBy: savedBy
datesSaved: datesSaved
comment: comment
whoSaved: whoSaved
whenSaved: whenSaved

savedBy: string,null

sec: string,null

time: string,null

updatedBy: string,null

validGrades: string,null

whenSaved: string,null

whoSaved: string,null

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

Community

 

Don't see your question listed here? Ask!