TAG LINE
SMALL TITLE

Usage / Class

(API Version v4)


What can you do with UsageClass?


Properties

Property Details
identity
READ-ONLY
"identity": 24
Type: Number
This is the unique numeric identifier for the UsageClass
name
"name": "Hello World"
Type: String
usageRaterTypeId
"usageRaterTypeId": 12
Type: Number
Unique identifier for the associated UsageRaterType object.
usageRaterTypeName
"usageRaterTypeName": "Sample Name"
Type: String
The name of the object associated with the usageRaterTypeId property.
usageBaseUnitId
"usageBaseUnitId": 12
Type: Number
Unique identifier for the associated UsageBaseUnit object.
usageBaseUnitName
"usageBaseUnitName": "Sample Name"
Type: String
The name of the object associated with the usageBaseUnitId property.
usageClassTypeId
"usageClassTypeId": 0
Type: Number
Unique identifier for the associated UsageClassType object.
usageClassTypeName
"usageClassTypeName": "Sample Name"
Type: String
The name of the object associated with the usageClassTypeId property.
serviceTaxCategoryId
"serviceTaxCategoryId": 7
Type: Number
Unique identifier for the associated ServiceTaxCategory object.
serviceTaxCategoryName
"serviceTaxCategoryName": "Sample Name"
Type: String
The name of the object associated with the serviceTaxCategoryId property.


End Points

DELETEapi/v4/Usage/Class/{id}
Delete an instance of the UsageClass object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the UsageClass object.
Delete an instance of the UsageClass object.
DELETE api/v4/Usage/Class/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "usageClass"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Usage/Class/
Retrieve all of the UsageClass objects.
Retrieve all of the UsageClass objects.
GET api/v4/Usage/Class/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "usageRaterTypeId": 23,
            "usageRaterTypeName": "Sample Text Data",
            "usageBaseUnitId": 27,
            "usageBaseUnitName": "Sample Text Data",
            "usageClassTypeId": 22,
            "usageClassTypeName": "Sample Text Data",
            "serviceTaxCategoryId": 6,
            "serviceTaxCategoryName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Usage/Class/AvailableFor/RateGroup/{id}/BaseUnit/{usageBaseUnitId}
For a given RateGroup and BaseUnit return the UsageClass objects that are available.
{id}Unique identifier for the RateGroup object.
{usageBaseUnitId}Unique identifier for the BaseUnit object.
GETapi/v4/Usage/Class/Paged
Retrieve all of the UsageClass 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 UsageClass objects in a paged fashion.
GET api/v4/Usage/Class/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",
                "usageRaterTypeId": 7,
                "usageRaterTypeName": "Sample Text Data",
                "usageBaseUnitId": 2,
                "usageBaseUnitName": "Sample Text Data",
                "usageClassTypeId": 20,
                "usageClassTypeName": "Sample Text Data",
                "serviceTaxCategoryId": 26,
                "serviceTaxCategoryName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Usage/Class/{id}
Retrieve an instance of the UsageClass object by its ID.
{id}Unique identifier for the UsageClass object.
Retrieve an instance of the UsageClass object by its ID.
GET api/v4/Usage/Class/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "usageRaterTypeId": 13,
        "usageRaterTypeName": "Sample Text Data",
        "usageBaseUnitId": 18,
        "usageBaseUnitName": "Sample Text Data",
        "usageClassTypeId": 2,
        "usageClassTypeName": "Sample Text Data",
        "serviceTaxCategoryId": 26,
        "serviceTaxCategoryName": "Sample Text Data"
    }
}
POSTapi/v4/Usage/Class/
Create a new instance of the UsageClass object.
Create a new instance of the UsageClass object.
POST api/v4/Usage/Class/

{
    "name": "Sample Text Data",
    "usageRaterTypeId": 22,
    "usageBaseUnitId": 13,
    "usageClassTypeId": 19,
    "serviceTaxCategoryId": 26
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "usageRaterTypeId": 4,
                "usageRaterTypeName": "Sample Text Data",
                "usageBaseUnitId": 0,
                "usageBaseUnitName": "Sample Text Data",
                "usageClassTypeId": 26,
                "usageClassTypeName": "Sample Text Data",
                "serviceTaxCategoryId": 1,
                "serviceTaxCategoryName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Usage/Class/Search
Retreive a list of UsageClass 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 UsageClass objects based on search criteria.
POST api/v4/Usage/Class/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "usageRaterTypeId": 0,
            "usageRaterTypeName": "Sample Text Data",
            "usageBaseUnitId": 27,
            "usageBaseUnitName": "Sample Text Data",
            "usageClassTypeId": 4,
            "usageClassTypeName": "Sample Text Data",
            "serviceTaxCategoryId": 13,
            "serviceTaxCategoryName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Usage/Class/{id}
Update an existing instance of the UsageClass object.
Update an existing instance of the UsageClass object.
PUT api/v4/Usage/Class/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "usageRaterTypeId": 17,
    "usageBaseUnitId": 23,
    "usageClassTypeId": 6,
    "serviceTaxCategoryId": 24
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "usageRaterTypeId": 7,
                "usageRaterTypeName": "Sample Text Data",
                "usageBaseUnitId": 11,
                "usageBaseUnitName": "Sample Text Data",
                "usageClassTypeId": 6,
                "usageClassTypeName": "Sample Text Data",
                "serviceTaxCategoryId": 24,
                "serviceTaxCategoryName": "Sample Text Data"
            }
        ]
    }
}