Get Limits for an Account or Balance Group

get

/bcws/webresources/v1.0/accounts/{id}/limits

Get limits for an account or balance group

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The balance group information was returned successfully.
Body ()
Root Schema : BalanceGroup
Type: object
Show Source
Nested Schema : balances
Type: array
The list of balances associated with the balance group.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : services
Type: array
Show Source
Nested Schema : Balances
Type: object
The list of balances associated with the balance group.
Show Source
Nested Schema : subBalances
Type: array
Show Source
Nested Schema : tempCreditLimit
Type: array
Show Source
Nested Schema : SubBalances
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : TempCreditLimit
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ServiceType
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : aliasList
Type: array
The list of aliases associated with the service.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get limits for a balance group by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/accounts/0.0.0.1+-account+174257/limits'

where:

  • hostname is the URL for the Billing Care REST server.
  • port is the port for the Billing Care REST server.
  • version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "id": "0.0.0.1+-balance_group+172465",
    "name": null,
    "services": [],
    "monitorType": null,
    "balances": [
        {
            "modifyLimit": null,
            "currentBalance": null,
            "dynamicCreditFloor": false,
            "creditFloor": null,
            "creditLimit": null,
            "overrideCreditLimit": 0,
            "creditThresholds": 0,
            "formattedCreditThresholds": null,
            "creditThresholdsFixed": "",
            "expiredBeforeUsing": null,
            "subBalances": [],
            "outstandingAmount": null,
            "loanThresholds": 0,
            "loanThresholdsFixed": "",
            "tempCreditLimit": [],
            "resourceId": 840
        }
    ],
    "elem": null
}
Back to Top