Udr / Usage / Bucket

(API Version v8)

Represents the amount used from a Bucket that is assigned to an Account Service.

What can you do with UDRUsageBucket?

GET Udr/UsageBucket/
Retrieve all of the UDRUsageBucket objects.
GET Udr/UsageBucket/Paged
Retrieve all of the UDRUsageBucket objects in a paged fashion.
GET Udr/UsageBucket/{id}
Retrieve an instance of the UDRUsageBucket object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 15 Type: Number This is the unique numeric identifier for the UDRUsageBucket
accountServiceUsageBucketId	"accountServiceUsageBucketId": 1 Type: Number Unique identifier for the associated AccountServiceUsageBucket object.
accountServiceUsageBucketName	"accountServiceUsageBucketName": "Sample Name" Type: String The name of the object associated with the accountServiceUsageBucketId property.
amount	"amount": 9 Type: Number Amount used from the Bucket.
start	"start": "2021-04-26T15:25:27.587Z" Type: Date Start date in which this Bucket was active during the period. Date and time values are specified in the ISO 8601 format.
end	"end": "2021-04-26T15:25:27.587Z" Type: Date End date for this Bucket during the period. Date and time values are specified in the ISO 8601 format.
created READ-ONLY	"created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.

End Points

Retrieve all of the UDRUsageBucket objects.

GET Udr/UsageBucket/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountServiceUsageBucketId": 18,
            "accountServiceUsageBucketName": "Sample Text Data",
            "amount": 8,
            "start": "2021-04-26T15:25:27.587Z",
            "end": "2021-04-26T15:25:27.587Z",
            "created": "2021-04-26T15:25:27.587Z"
        }
    ]
}

Retrieve all of the UDRUsageBucket 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 UDRUsageBucket objects in a paged fashion.

GET Udr/UsageBucket/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,
                "accountServiceUsageBucketId": 22,
                "accountServiceUsageBucketName": "Sample Text Data",
                "amount": 20,
                "start": "2021-04-26T15:25:27.587Z",
                "end": "2021-04-26T15:25:27.587Z",
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}

GET	Udr/UsageBucket/{id}
Retrieve an instance of the UDRUsageBucket object by its ID.
{id}	Unique identifier for the UDRUsageBucket object.
Retrieve an instance of the UDRUsageBucket object by its ID. GET Udr/UsageBucket/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "accountServiceUsageBucketId": 14, "accountServiceUsageBucketName": "Sample Text Data", "amount": 3, "start": "2021-04-26T15:25:27.587Z", "end": "2021-04-26T15:25:27.587Z", "created": "2021-04-26T15:25:27.587Z" } }