TAG LINE
TAG LINE
SMALL TITLE
Defines a different system rating types such as location or class based rating.
identity READ-ONLY | "identity": 13 Type: Number This is the unique numeric identifier for the UsageRaterType |
name READ-ONLY | "name": "Class-Based" Type: String The system defined name for the Rater Type |
description READ-ONLY | "description": "Class-Based" Type: String The system description for the Rater Type. |
sortOrder READ-ONLY | "sortOrder": 27 Type: Number Unused |
visible READ-ONLY | "visible": true Type: Boolean Unused |
| GET | Usage/RaterType/ |
| Retrieve all of the UsageRaterType objects. | |
Retrieve all of the UsageRaterType objects. GET Usage/RaterType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Class-Based",
"description": "Class-Based",
"sortOrder": 20,
"visible": true
}
]
} | |
| GET | Usage/RaterType/Paged |
| Retrieve all of the UsageRaterType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the UsageRaterType objects in a paged fashion. GET Usage/RaterType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Class-Based",
"description": "Class-Based",
"sortOrder": 12,
"visible": true
}
]
}
} | |
| GET | Usage/RaterType/{id} |
| Retrieve an instance of the UsageRaterType object by its ID. | |
| {id} | Unique identifier for the UsageRaterType object. |
Retrieve an instance of the UsageRaterType object by its ID. GET Usage/RaterType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Class-Based",
"description": "Class-Based",
"sortOrder": 24,
"visible": true
}
} | |