TAG LINE
TAG LINE
SMALL TITLE
Defines a system list of different calculation types such as Rated, Fixed etc.
identity READ-ONLY | "identity": 23 Type: Number This is the unique numeric identifier for the UsageRateCalculationType |
name | "name": "Rated" Type: String The system defined name for the Calculation Type |
description | "description": "Rated" Type: String The system defined description for the Calculation Type |
sortOrder READ-ONLY | "sortOrder": 17 Type: Number Unused |
visible READ-ONLY | "visible": true Type: Boolean Unused |
| GET | Usage/Rate/CalculationType/ |
| Retrieve all of the UsageRateCalculationType objects. | |
Retrieve all of the UsageRateCalculationType objects. GET Usage/Rate/CalculationType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Rated",
"description": "Rated",
"sortOrder": 23,
"visible": true
}
]
} | |
| GET | Usage/Rate/CalculationType/Paged |
| Retrieve all of the UsageRateCalculationType 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 UsageRateCalculationType objects in a paged fashion. GET Usage/Rate/CalculationType/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": "Rated",
"description": "Rated",
"sortOrder": 4,
"visible": true
}
]
}
} | |
| GET | Usage/Rate/CalculationType/{id} |
| Retrieve an instance of the UsageRateCalculationType object by its ID. | |
| {id} | Unique identifier for the UsageRateCalculationType object. |
Retrieve an instance of the UsageRateCalculationType object by its ID. GET Usage/Rate/CalculationType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Rated",
"description": "Rated",
"sortOrder": 3,
"visible": true
}
} | |