TAG LINE
SMALL TITLE

Usage / Rate

(API Version v2)


What can you do with UsageRate?


Properties

Property Details
id
"id": 3
Type: Number
This is the unique numeric identifier for the UsageRate
usageRateGroupId
"usageRateGroupId": 10
Type: Number
Unique identifier for the associated UsageRateGroup object.
usageClassId
"usageClassId": 26
Type: Number
Unique identifier for the associated UsageClass object.
amount
"amount": "Hello World"
Type: String
geoTreeLocationId
"geoTreeLocationId": 19
Type: Number
Unique identifier for the associated GeoTreeLocation object.
additional
"additional": true
Type: Boolean
retired
"retired": true
Type: Boolean
ownerId
"ownerId": 5
Type: Number
Unique identifier for the associated Owner object.
usageRoundingId
"usageRoundingId": 11
Type: Number
Unique identifier for the associated UsageRounding object.
displayName
"displayName": "Hello World"
Type: String
geoTreeLocationGroupId
"geoTreeLocationGroupId": 27
Type: Number
Unique identifier for the associated GeoTreeLocationGroup object.
minimumCharge
"minimumCharge": "Hello World"
Type: String
usageUnitId
"usageUnitId": 9
Type: Number
Unique identifier for the associated UsageUnit object.
usageRateCalculationTypeId
"usageRateCalculationTypeId": 15
Type: Number
Unique identifier for the associated UsageRateCalculationType 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:

  • usageRateGroupId
  • usageClassId
  • amount
  • geoTreeLocationId
  • additional
  • retired
  • usageRoundingId
  • displayName
  • geoTreeLocationGroupId
  • minimumCharge
  • usageUnitId
  • usageRateCalculationTypeId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the UsageRate object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Usage/Rate/{id:int}
Delete an instance of the UsageRate object.
GETapi/v2/Usage/Rate
Retrieve all of the UsageRate objects.
GETapi/v2/Usage/Rate/Paged
Retreive all of the UsageRate objects in a paged fashion.
GETapi/v2/Usage/Rate/Paged/Detail
Retreive all of the UsageRate objects in a paged fashion with all object details.
GETapi/v2/Usage/Rate/{id:int}
Retrieve an instance of the UsageRate object by it's ID.
{id:int}Unique identifier for the UsageRate object.
GETapi/v2/Usage/Rate/{id:int}/Detail
Retreive all of the Detail objects for the specified UsageRate.
{id:int}Unique identifier for the UsageRate object.
PATCHapi/v2/Usage/Rate/{id:int}
Update the UsageRate object and optionally make changes to any child objects.
POSTapi/v2/Usage/Rate
Create a new instance of the UsageRate object.
PUTapi/v2/Usage/Rate/{id:int}
Update an existing instance of the UsageRate object.