TAG LINE
SMALL TITLE

Udr / Usage / Exception Type

(API Version v3)


Internal descriptions of different types of usage exceptions.


What can you do with UDRUsageExceptionType?


Properties

Property Details
identity
READ-ONLY
"identity": 26
Type: Number
This is the unique numeric identifier for the UDRUsageExceptionType
name
READ-ONLY
"name": "Rate not found"
Type: String
System name of the Exception Type.
sortOrder
READ-ONLY
"sortOrder": 0
Type: Number
Unused
description
READ-ONLY
"description": "A rate could not be found for the associated usage"
Type: String
Description of the Exception Type


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • sortOrder
  • description

End Points

GETapi/v3/Udr/Usage/ExceptionType/
Retrieve all of the UDRUsageExceptionType objects.
Retrieve all of the UDRUsageExceptionType objects.
GET api/v3/Udr/Usage/ExceptionType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Rate not found",
            "sortOrder": 20,
            "description": "A rate could not be found for the associated usage"
        }
    ]
}
GETapi/v3/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/v3/Udr/Usage/ExceptionType/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,
                "name": "Rate not found",
                "sortOrder": 4,
                "description": "A rate could not be found for the associated usage"
            }
        ]
    }
}
GETapi/v3/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/v3/Udr/Usage/ExceptionType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Rate not found",
        "sortOrder": 20,
        "description": "A rate could not be found for the associated usage"
    }
}