TAG LINE
TAG LINE
SMALL TITLE

Usage Rated Exception Type

(API Version v9)


Details the types of usage rated exception.


What can you do with UsageRatedExceptionType?


Properties

Property Details
identity
READ-ONLY
"identity": 6
Type: Number
This is the unique numeric identifier for the UsageRatedExceptionType
sortOrder
"sortOrder": 9
Type: Number
The order of the exception.
description
"description": "Unable to find or apply rate for the record"
Type: String
The description of the exception.
name
"name": "Rate Not Found"
Type: String
The name of the exception.


End Points

GETUsageRatedExceptionType/
Retrieve all of the UsageRatedExceptionType objects.
Retrieve all of the UsageRatedExceptionType objects.
GET UsageRatedExceptionType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "sortOrder": 13,
            "description": "Unable to find or apply rate for the record",
            "name": "Rate Not Found"
        }
    ]
}
GETUsageRatedExceptionType/Paged
Retrieve all of the UsageRatedExceptionType 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 UsageRatedExceptionType objects in a paged fashion.
GET UsageRatedExceptionType/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "sortOrder": 23,
                "description": "Unable to find or apply rate for the record",
                "name": "Rate Not Found"
            }
        ]
    }
}
GETUsageRatedExceptionType/{id}
Retrieve an instance of the UsageRatedExceptionType object by its ID.
{id}Unique identifier for the UsageRatedExceptionType object.
Retrieve an instance of the UsageRatedExceptionType object by its ID.
GET UsageRatedExceptionType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "sortOrder": 17,
        "description": "Unable to find or apply rate for the record",
        "name": "Rate Not Found"
    }
}