TAG LINE
TAG LINE
SMALL TITLE
Internal descriptions of different types of usage exceptions.
identity READ-ONLY | "identity": 17 Type: Number This is the unique numeric identifier for the UDRUsageExceptionType |
sortOrder READ-ONLY | "sortOrder": 24 Type: Number Unused |
description READ-ONLY | "description": "A rate could not be found for the associated usage" Type: String Description of the Exception Type |
name READ-ONLY | "name": "Rate not found" Type: String System name of the Exception Type. |
GET | api/v4/Udr/Usage/ExceptionType/ |
Retrieve all of the UDRUsageExceptionType objects. | |
Retrieve all of the UDRUsageExceptionType objects. GET api/v4/Udr/Usage/ExceptionType/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "sortOrder": 22, "description": "A rate could not be found for the associated usage", "name": "Rate not found" } ] } |
GET | api/v4/Udr/Usage/ExceptionType/Paged |
Retrieve all of the UDRUsageExceptionType 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 UDRUsageExceptionType objects in a paged fashion. GET api/v4/Udr/Usage/ExceptionType/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, "sortOrder": 9, "description": "A rate could not be found for the associated usage", "name": "Rate not found" } ] } } |
GET | api/v4/Udr/Usage/ExceptionType/{id} |
Retrieve an instance of the UDRUsageExceptionType object by its ID. | |
{id} | Unique identifier for the UDRUsageExceptionType object. |
Retrieve an instance of the UDRUsageExceptionType object by its ID. GET api/v4/Udr/Usage/ExceptionType/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "sortOrder": 12, "description": "A rate could not be found for the associated usage", "name": "Rate not found" } } |
POST | api/v4/Udr/Usage/ExceptionType/Search |
Retreive a list of UDRUsageExceptionType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST. | |
Retreive a list of UDRUsageExceptionType objects based on search criteria. POST api/v4/Udr/Usage/ExceptionType/Search { "query": { "top": 20, "search": [ { "name": "MyFieldName", "operator": "startsWith", "value": "a" } ] } } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "itemCount": 1, "items": [ { "identity": 1, "sortOrder": 19, "description": "A rate could not be found for the associated usage", "name": "Rate not found" } ] } |