1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Prepay Balance Management
  4. Bucket Balances

Get Bucket Balances

get

/bucket

Gets the bucket balances that match the specified query criteria.

Request

Query Parameters
  • The type of object to return.
    Example:
    Use @type=Bucket for a base object or @type=BucketOracle for an extended object.
  • The list of comma-separated fields to return in the response.
    Example:
    <b>fields=name,partyAccount,product</b>.
  • The maximum number of results to return.
    Example:
    Use limit=10 to return the first 10 results only.
  • The number of results to offset the response by.
    Example:
    Use offset=10 to return results 10 and higher.
  • Retrieves the buckets for the product with the specified ID.
    Example:
    product.id=0.0.0.1+-service-telco-gsm+67479

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Headers
Body ()
Root Schema : schema
Type: array
Show Source
  • Bucket
    Title: Bucket
    A bucket that tracks a quantity of usage (remaining or consumed) for currency or non-currency resources (such as messages, minutes, data).
Nested Schema : Bucket
Type: object
Title: Bucket
A bucket that tracks a quantity of usage (remaining or consumed) for currency or non-currency resources (such as messages, minutes, data).
Show Source
Nested Schema : logicalResource
Type: array
Logical resources associated with the bucket.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : product
Type: array
Products associated with the bucket.
Show Source
Nested Schema : relatedParty
Type: array
Parties related to the bucket.
Show Source
Nested Schema : Quantity
Type: object
An amount in a given unit.
Show Source
Nested Schema : TimePeriod
Type: object
A period of time.
Show Source
Nested Schema : Logical Resource Ref
Type: object
Title: Logical Resource Ref
A reference to a logical resource.
Show Source
Nested Schema : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

Method Not allowed
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

The following example shows how to get bucket balances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the product.id query parameters to restrict the results. 

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/bucket?&product.id=0.0.0.1+-service-telco-gsm-sms+102975'

Example of the Response Body

The following example shows the contents of the response body in JSON format.

[
    {
        "id": "0.0.0.1+-balance_group+106463",
        "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+106463",
        "confirmationDate": null,
        "description": null,
        "isShared": null,
        "name": "Account Balance Group",
        "remainingValueName": null,
        "requestedDate": null,
        "logicalResource": null,
        "partyAccount": {
            "id": "0.0.0.1+-account+102879",
            "href": null,
            "description": null,
            "name": "James Kurup",
            "status": "active",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "PartyAccountRef",
            "@referredType": null
        },
        "product": [
            {
                "id": "0.0.0.1+-service-telco-gsm-sms+102975",
                "href": null,
                "name": "ServiceTelcoGsmSms",
                "@baseType": null,
                "@schemaLocation": null,
                "@type": "ProductRef",
                "@referredType": null
            },
            {
                "id": "0.0.0.1+-service-telco-gsm-telephony+104255",
                "href": null,
                "name": "ServiceTelcoGsmTelephony",
                "@baseType": null,
                "@schemaLocation": null,
                "@type": "ProductRef",
                "@referredType": null
            }
        ],
        "relatedParty": null,
        "remainingValue": {
            "amount": 45.0,
            "units": "EUR",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "Quantity"
        },
        "reservedValue": {
            "amount": 0.0,
            "units": "EUR",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "Quantity"
        },
        "status": "ACTIVE",
        "usageType": null,
        "validFor": {
            "endDateTime": null,
            "startDateTime": "2020-05-02T00:00:00-07:00"
        },
        "@baseType": "Bucket",
        "@schemaLocation": null,
        "@type": "Bucket"
       }
]
Back to Top