TAG LINE
TAG LINE
SMALL TITLE
Defines a Rounding Rule to be used with a Usage Rate.
identity READ-ONLY | "identity": 17 Type: Number This is the unique numeric identifier for the UsageRounding |
name | "name": "Round Up 6/60" Type: String The user defined name for the Rounding Rule |
description | "description": "Round up in increments of 60" Type: String The user description for the Rounding Rule. |
minimum | "minimum": 23 Type: Number The floor in which to round up to. |
increment | "increment": 25 Type: Number The increment of rounding. |
sortOrder READ-ONLY | "sortOrder": 15 Type: Number Unused |
usageUnitId | "usageUnitId": 14 Type: Number Unique identifier for the associated UsageUnit object. |
usageUnitName | "usageUnitName": "Sample Name" Type: String The name of the object associated with the usageUnitId property. |
isActive | "isActive": true Type: Boolean Whether or not this Rule can be assigned in the system. |
ownerId READ-ONLY | "ownerId": 18 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. |
| DELETE | Usage/Rounding/{id} |
| Delete an instance of the UsageRounding object. Upon successful delete, this API will return a record of all of the related 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 UsageRounding object. |
Delete an instance of the UsageRounding object. DELETE Usage/Rounding/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageRounding"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Usage/Rounding/ |
| Retrieve all of the UsageRounding objects. | |
Retrieve all of the UsageRounding objects. GET Usage/Rounding/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Round Up 6/60",
"description": "Round up in increments of 60",
"minimum": 16,
"increment": 10,
"sortOrder": 26,
"usageUnitId": 22,
"usageUnitName": "Sample Text Data",
"isActive": true,
"ownerId": 4,
"ownerName": "Sample Text Data"
}
]
} | |
| GET | Usage/Rounding/Paged |
| Retrieve all of the UsageRounding 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 UsageRounding objects in a paged fashion. GET Usage/Rounding/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,
"name": "Round Up 6/60",
"description": "Round up in increments of 60",
"minimum": 23,
"increment": 4,
"sortOrder": 7,
"usageUnitId": 11,
"usageUnitName": "Sample Text Data",
"isActive": true,
"ownerId": 2,
"ownerName": "Sample Text Data"
}
]
}
} | |
| GET | Usage/Rounding/{id} |
| Retrieve an instance of the UsageRounding object by its ID. | |
| {id} | Unique identifier for the UsageRounding object. |
Retrieve an instance of the UsageRounding object by its ID. GET Usage/Rounding/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Round Up 6/60",
"description": "Round up in increments of 60",
"minimum": 8,
"increment": 27,
"sortOrder": 7,
"usageUnitId": 21,
"usageUnitName": "Sample Text Data",
"isActive": true,
"ownerId": 0,
"ownerName": "Sample Text Data"
}
} | |
| POST | Usage/Rounding/ |
| Create a new instance of the UsageRounding object. | |
Create a new instance of the UsageRounding object. POST Usage/Rounding/
{
"name": "Round Up 6/60",
"description": "Round up in increments of 60",
"minimum": 2,
"increment": 7,
"usageUnitId": 13,
"isActive": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Round Up 6/60",
"description": "Round up in increments of 60",
"minimum": 6,
"increment": 10,
"sortOrder": 4,
"usageUnitId": 19,
"usageUnitName": "Sample Text Data",
"isActive": true,
"ownerId": 24,
"ownerName": "Sample Text Data"
}
]
}
} | |
| PUT | Usage/Rounding/{id} |
| Update an existing instance of the UsageRounding object. | |
Update an existing instance of the UsageRounding object. PUT Usage/Rounding/{id}
{
"identity": 1,
"name": "Round Up 6/60",
"description": "Round up in increments of 60",
"minimum": 27,
"increment": 0,
"usageUnitId": 3,
"isActive": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Round Up 6/60",
"description": "Round up in increments of 60",
"minimum": 25,
"increment": 2,
"sortOrder": 5,
"usageUnitId": 2,
"usageUnitName": "Sample Text Data",
"isActive": true,
"ownerId": 15,
"ownerName": "Sample Text Data"
}
]
}
} | |