TAG LINE
SMALL TITLE

Usage / Rater Type

(API Version v2)


Defines a different system rating types such as location or class based rating.


What can you do with UsageRaterType?


Properties

Property Details
identity
READ-ONLY
"identity": 7
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": 4
Type: Number
Unused
visible
READ-ONLY
"visible": true
Type: Boolean
Unused


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
  • description
  • sortOrder
  • visible

End Points

GETapi/v2/Usage/RaterType/
Retrieve all of the UsageRaterType objects.
Retrieve all of the UsageRaterType objects.
GET api/v2/Usage/RaterType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Class-Based",
            "description": "Class-Based",
            "sortOrder": 2,
            "visible": true
        }
    ]
}
GETapi/v2/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 api/v2/Usage/RaterType/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": "Class-Based",
                "description": "Class-Based",
                "sortOrder": 22,
                "visible": true
            }
        ]
    }
}
GETapi/v2/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 api/v2/Usage/RaterType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Class-Based",
        "description": "Class-Based",
        "sortOrder": 12,
        "visible": true
    }
}