AcademicGradesGradeAssist

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

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

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

Version: v1

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

Summary

Path Operation Description
/delete/{year_term}/{teaching_area}/{catalog_number}/{section_number}/{person_id}/{assistant_type) DELETE

Deletes a specified person as a GRADE or TEACHING assistant to a class

/documentation GET

service definition

/{year_term}/{person_id} GET

Gets the sections that the specified student is an assistant for

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

Gets all of the assistants for the specified section

/{year_term}/{teaching_area}/{catalog_number}/{section_number}/{person_id} PUT

Adds a specified person as a GRADE or TEACHING assistant to a class

Paths

Deletes a specified person as a GRADE or TEACHING assistant to a class

DELETE /delete/{year_term}/{teaching_area}/{catalog_number}/{section_number}/{person_id}/{assistant_type)

Tags: GradeAssist_v2Service

Deletes a specified person as a GRADE or TEACHING assistant to a class

year_term

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

path string
teaching_area

string ->

path string
catalog_number

string ->

path string
section_number

string ->

path string
person_id

string ->

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

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.

service definition

GET /documentation

service definition

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

200 OK

Success

Gets the sections that the specified student is an assistant for

GET /{year_term}/{person_id}

Tags: GradeAssist_v2Service

Gets the sections that the specified student is an assistant for

year_term

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

path string
person_id

string ->

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

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.

Gets all of the assistants for the specified section

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

Tags: GradeAssist_v2Service

Gets all of the assistants for the specified section

year_term

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

path string
teaching_area

string ->

path string
catalog_number

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.

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.

Adds a specified person as a GRADE or TEACHING assistant to a class

PUT /{year_term}/{teaching_area}/{catalog_number}/{section_number}/{person_id}

Tags: GradeAssist_v2Service

Adds a specified person as a GRADE or TEACHING assistant to a class

year_term

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

path string
teaching_area

string ->

path string
catalog_number

string ->

path string
section_number

string ->

path string
person_id

string ->

path string
assistant_type

Must be 'GRADE ASSISTANT' or 'TEACHING ASSISTANT'

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.

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

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

Community

 

Don't see your question listed here? Ask!