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

Get Bucket Balances by ID

get

/bucket/{id}

Gets the specified bucket balance.

Request

Path Parameters
Query Parameters
  • The type of object to return. Use @type=Bucket for a base object or @type=BucketOracle for an extended object.
    Example:
    Bucket
  • The list of comma-separated fields to return in the response.
    Example:
    name,usageType

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : Bucket
Type: object
Title: Bucket
A bucket that tracks a quantity of usage (remaining or consumed) for currency or noncurrency 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. (BRM does not use this property.)
Show Source
Nested Schema : Quantity
Type: object
Title: Quantity
The quantity of an object.
Show Source
Nested Schema : Time Period
Type: object
Title: Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
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
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
Back to Top

Examples

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

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+109933'

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+109933",
    "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+109933",
    "confirmationDate": null,
    "description": null,
    "isShared": null,
    "name": "Account Balance Group",
    "remainingValueName": null,
    "requestedDate": null,
    "logicalResource": null,
    "partyAccount": {
        "id": "0.0.0.1+-account+107117",
        "href": null,
        "description": null,
        "name": "Tanya Levy",
        "status": "active",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": "PartyAccountRef",
        "@referredType": null
    },
    "product": [
        {
            "id": "0.0.0.1+-service-telco-gsm-sms+106733",
            "href": null,
            "name": "ServiceTelcoGsmSms",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "ProductRef",
            "@referredType": null
        },
        {
            "id": "0.0.0.1+-service-telco-gsm-telephony+108013",
            "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