TAG LINE
SMALL TITLE

Usage / Class

(API Version v3)


What can you do with UsageClass?


Properties

Property Details
id
"id": 17
Type: Number
This is the unique numeric identifier for the UsageClass
name
"name": "Hello World"
Type: String
usageRaterTypeId
"usageRaterTypeId": 20
Type: Number
Unique identifier for the associated UsageRaterType object.
usageBaseUnitId
"usageBaseUnitId": 12
Type: Number
Unique identifier for the associated UsageBaseUnit object.
usageClassTypeId
"usageClassTypeId": 1
Type: Number
Unique identifier for the associated UsageClassType object.


Update Request Filters

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
  • usageRaterTypeId
  • usageBaseUnitId
  • usageClassTypeId

DataFlow PATCH objects:


End Points

DELETEapi/v3/Usage/Class/{id:int}
Delete an instance of the UsageClass object.
GETapi/v3/Usage/Class
Retrieve all of the UsageClass objects.
GETapi/v3/Usage/Class/AvailableFor/RateGroup/{usageRateGroupId:int}/BaseUnit/{usageBaseUnitId:int}
Retrieve all of the UsageClass objects.
GETapi/v3/Usage/Class/Paged
Retreive all of the UsageClass objects in a paged fashion.
GETapi/v3/Usage/Class/{id:int}
Retrieve an instance of the UsageClass object by it's ID.
{id:int}Unique identifier for the UsageClass object.
POSTapi/v3/Usage/Class
Create a new instance of the UsageClass object.
PUTapi/v3/Usage/Class/{id:int}
Update an existing instance of the UsageClass object.