TAG LINE
SMALL TITLE

Usage / Rounding

(API Version v4)


Defines a Rounding Rule to be used with a Usage Rate.


What can you do with UsageRounding?


Properties

Property Details
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": 17
Type: Number
The floor in which to round up to.
increment
"increment": 25
Type: Number
The increment of rounding.
sortOrder
READ-ONLY
"sortOrder": 6
Type: Number
Unused
usageUnitId
"usageUnitId": 1
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": 14
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.


End Points

DELETEapi/v4/Usage/Rounding/{id}
Delete an instance of the UsageRounding 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 UsageRounding object.
Delete an instance of the UsageRounding object.
DELETE api/v4/Usage/Rounding/{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": "usageRounding"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Usage/Rounding/
Retrieve all of the UsageRounding objects.
Retrieve all of the UsageRounding objects.
GET api/v4/Usage/Rounding/
View Sample Response
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": 13,
            "increment": 12,
            "sortOrder": 15,
            "usageUnitId": 3,
            "usageUnitName": "Sample Text Data",
            "isActive": true,
            "ownerId": 9,
            "ownerName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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 api/v4/Usage/Rounding/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": "Round Up 6/60",
                "description": "Round up in increments of 60",
                "minimum": 27,
                "increment": 18,
                "sortOrder": 26,
                "usageUnitId": 27,
                "usageUnitName": "Sample Text Data",
                "isActive": true,
                "ownerId": 3,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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 api/v4/Usage/Rounding/{id}
View Sample Response
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": 14,
        "increment": 1,
        "sortOrder": 8,
        "usageUnitId": 19,
        "usageUnitName": "Sample Text Data",
        "isActive": true,
        "ownerId": 21,
        "ownerName": "Sample Text Data"
    }
}
POSTapi/v4/Usage/Rounding/
Create a new instance of the UsageRounding object.
Create a new instance of the UsageRounding object.
POST api/v4/Usage/Rounding/

{
    "name": "Round Up 6/60",
    "description": "Round up in increments of 60",
    "minimum": 14,
    "increment": 5,
    "usageUnitId": 11,
    "isActive": true
}
View Sample Response
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": 17,
                "increment": 6,
                "sortOrder": 17,
                "usageUnitId": 4,
                "usageUnitName": "Sample Text Data",
                "isActive": true,
                "ownerId": 26,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Usage/Rounding/Search
Retreive a list of UsageRounding 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 UsageRounding objects based on search criteria.
POST api/v4/Usage/Rounding/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": "Round Up 6/60",
            "description": "Round up in increments of 60",
            "minimum": 11,
            "increment": 17,
            "sortOrder": 25,
            "usageUnitId": 9,
            "usageUnitName": "Sample Text Data",
            "isActive": true,
            "ownerId": 6,
            "ownerName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Usage/Rounding/{id}
Update an existing instance of the UsageRounding object.
Update an existing instance of the UsageRounding object.
PUT api/v4/Usage/Rounding/{id}

{
    "identity": 1,
    "name": "Round Up 6/60",
    "description": "Round up in increments of 60",
    "minimum": 8,
    "increment": 20,
    "usageUnitId": 2,
    "isActive": true
}
View Sample Response
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": 27,
                "increment": 11,
                "sortOrder": 4,
                "usageUnitId": 27,
                "usageUnitName": "Sample Text Data",
                "isActive": true,
                "ownerId": 5,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}