AcademicGradesGradeChange
GradeChangeService
Base URL: /domains/legacy/academic/grades/gradechange
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{year_term}/{curriculum_id}/{title_code}/{section} | GET | Returns the enrolled students for the given class with all current grades |
| PUT | Changes grades for students in the given class section. Either the grade_changes parameter or the t_grade_changes parameter or both must be provided. |
Paths
GET /documentation
service definition
Uses default content-types: application/json
- 200 OK
-
Success
GET /{year_term}/{curriculum_id}/{title_code}/{section}
Tags: GradeChangeServiceReturns the enrolled students for the given class with all current grades
| 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 | 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/20175/01489/002/002/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"catalog_number": "142",
"catalog_suffix": "",
"class_end_date": "21 Dec 2017",
"class_start_date": "05 Sep 2017",
"class_title": "Intro to Computer Programming",
"department_name": "C S",
"grade_details": [
{
"byu_id": "123456789",
"date_graded": "03 Jan 2018",
"grade": "A",
"graded_by": "Teacher, Name",
"graded_by_id": "123456789",
"name": "Student, Name",
"person_id": "123456789"
}
],
"grade_rule": "12",
"grade_rule_description": "Inclusive Grade Rule: A B C D E I P T",
"instructor_name": "Teacher, Professor",
"instructor_person_id": "123456789",
"year_term_description": "Fall 2017"
}
} - 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.
PUT /{year_term}/{curriculum_id}/{title_code}/{section}
Tags: GradeChangeServiceChanges grades for students in the given class section. Either the grade_changes parameter or the t_grade_changes parameter or both must be provided.
| 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 | string -> Must be 3 digit number. i.e. 001 for section one. | path | string | |
| t_grade_changes | Repeating string formateed as person_id, grade, reason, change_all_year_terms(Y,N)... | query | string |
Uses default content-types: application/json
- 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
- person_id: person_id
-
- byu_id: byu_id
-
- name: name
-
- grade: grade
-
- date_graded: date_graded
-
- graded_by_id: graded_by_id
-
- graded_by: graded_by
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- department_name: department_name
-
- catalog_number: catalog_number
-
- catalog_suffix: catalog_suffix
-
- instructor_person_id: instructor_person_id
-
- instructor_name: instructor_name
-
- grade_rule: grade_rule
-
- grade_rule_description: grade_rule_description
-
- year_term_description: year_term_description
-
- class_title: class_title
-
- class_start_date: class_start_date
-
- class_end_date: class_end_date
-
- grade_details: grade_details
-
