TAG LINE
SMALL TITLE
Defines a container that holds multiple Rate Groups. These are assigned to Packages within the system.
identity READ-ONLY | "identity": 22 Type: Number This is the unique numeric identifier for the UsageRatePlan |
ownerId READ-ONLY | "ownerId": 22 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "All Data Rates" Type: String The user defined name for the Rate Plan |
displayName | "displayName": "Gold Rates" Type: String The user defined "friendly" name for this Rate Plan to display on reports etc. |
amountPrecision | "amountPrecision": 2 Type: Number The number of decimal places to round. Maximum of 11. |
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:
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 UsageRatePlan object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v2/Usage/Rate/Plan/{id} |
| Delete an instance of the UsageRatePlan 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 UsageRatePlan object. |
Delete an instance of the UsageRatePlan object. DELETE api/v2/Usage/Rate/Plan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageRatePlan"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/Usage/Rate/Plan/ |
| Retrieve all of the UsageRatePlan objects. | |
Retrieve all of the UsageRatePlan objects. GET api/v2/Usage/Rate/Plan/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 19,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 12
}
]
} | |
| GET | api/v2/Usage/Rate/Plan/Paged |
| Retrieve all of the UsageRatePlan 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 UsageRatePlan objects in a paged fashion. GET api/v2/Usage/Rate/Plan/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 13,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 18
}
]
}
} | |
| GET | api/v2/Usage/Rate/Plan/Paged/Detail |
| Retrieve all of the UsageRatePlan objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the UsageRatePlan objects in a paged fashion with all object details. GET api/v2/Usage/Rate/Plan/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 16,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 18,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v2/Usage/Rate/Plan/{id} |
| Retrieve an instance of the UsageRatePlan object by its ID. | |
| {id} | Unique identifier for the UsageRatePlan object. |
Retrieve an instance of the UsageRatePlan object by its ID. GET api/v2/Usage/Rate/Plan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 9,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 19
}
} | |
| GET | api/v2/Usage/Rate/Plan/{id}/Detail |
| Retrieve deep detail of the UsageRatePlan object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the UsageRatePlan object. |
Retrieve deep detail of the UsageRatePlan object by its ID. GET api/v2/Usage/Rate/Plan/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 1,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 20,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| PATCH | api/v2/Usage/Rate/Plan/{id} |
| Update or Add the UsageRatePlan object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the UsageRatePlan object. |
Update or Add the UsageRatePlan object and optionally make changes to any child objects. PATCH api/v2/Usage/Rate/Plan/{id}
{
"details": {},
"usageRatePlans": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 23
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "usageRatePlan",
"instance": {
"identity": 1,
"ownerId": 9,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 7
}
}
]
}
} | |
| POST | api/v2/Usage/Rate/Plan/ |
| Create a new instance of the UsageRatePlan object. | |
Create a new instance of the UsageRatePlan object. POST api/v2/Usage/Rate/Plan/
{
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 26
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 11,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 19
}
]
}
} | |
| PUT | api/v2/Usage/Rate/Plan/{id} |
| Update an existing instance of the UsageRatePlan object. | |
Update an existing instance of the UsageRatePlan object. PUT api/v2/Usage/Rate/Plan/{id}
{
"identity": 1,
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 5
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 0,
"ownerName": "Sample Text Data",
"name": "All Data Rates",
"displayName": "Gold Rates",
"amountPrecision": 6
}
]
}
} | |