You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Grade API can perform functions to interact or exchange data for Grade.
![](/community/download/attachments/51577330/image2019-8-20_17-3-5.png?version=1&modificationDate=1566291785000&api=v2)
| Name | Description |
---|
1 | | Name | Description |
---|
URL | /grade | HTTP Method | POST | Body Parameters | Parameter | Description |
---|
id | Department ID. | name | Department name. | description | Description of department. |
| Sample Response | |
|
2 | |
Delete a grade via grade ID.
Name | Description |
---|
URL | /grade/{id} | HTTP Method | DELETE | Path Parameters | Parameter | Description |
---|
id | Department ID. |
| Sample Response | |
|
3 | |
Gets all grades from all organizations by default. Able to filter or sort the returned results via parameters.
Name | Description |
---|
URL | /grade/find | HTTP Method | GET | Query String Parameters | Parameter | Description |
---|
nameFilter | Filters the response via department ID. | organizationId | Filter departments that belong to an organization, via organization ID. | sort | Department data column to sort. Must be used in conjunction with "sortDescending" parameter. | sortDescending | Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter. | startOffset | Starting position of records to start query. Expects an integer. | pageSize | Number of results to return. Expects an integer. |
| Sample Response | |
|
4 | |
Get details of a grade via grade ID.
Name | Description |
---|
URL | /grade/{id} | HTTP Method | GET | Path Parameters | Parameter | Description |
---|
id | Department ID. |
| Sample Response | |
|
5 | |
Update the details of a grade.
Name | Description |
---|
URL | /grade | HTTP Method | PUT | Body Parameters | Parameter | Description |
---|
id | Department ID. | name | Department name. | description | Description of department. |
| Sample Response | |
|