TAG LINE
TAG LINE
SMALL TITLE

Usage / Class / Group Type

(API Version v6)


What can you do with UsageClassGroupType?


Properties

Property Details
identity
READ-ONLY
"identity": 20
Type: Number
This is the unique numeric identifier for the UsageClassGroupType
name
"name": "Hello World"
Type: String
usageClassId
"usageClassId": 10
Type: Number
Unique identifier for the associated UsageClass object.
usageClassName
"usageClassName": "Sample Name"
Type: String
The name of the object associated with the usageClassId property.


End Points

GETUsage/Class/GroupType/
Retrieve all of the UsageClassGroupType objects.
Retrieve all of the UsageClassGroupType objects.
GET Usage/Class/GroupType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "usageClassId": 8,
            "usageClassName": "Sample Text Data"
        }
    ]
}
GETUsage/Class/GroupType/Paged
Retrieve all of the UsageClassGroupType 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 UsageClassGroupType objects in a paged fashion.
GET Usage/Class/GroupType/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": "Sample Text Data",
                "usageClassId": 27,
                "usageClassName": "Sample Text Data"
            }
        ]
    }
}
GETUsage/Class/GroupType/{id}
Retrieve an instance of the UsageClassGroupType object by its ID.
{id}Unique identifier for the UsageClassGroupType object.
Retrieve an instance of the UsageClassGroupType object by its ID.
GET Usage/Class/GroupType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "usageClassId": 3,
        "usageClassName": "Sample Text Data"
    }
}