Jump to

• Request
• Response
• Examples

Get Deposit Specifications or Offers

get

/bcws/webresources/v1.0/depositManagement/depositSpec

Gets the deposit specifications or offers that match the query criteria.

Request

Query Parameters

• expiresAt: string
  The deposit specification expiry date, for example: 2037-09-18T18:30:00.000Z
• limit: string
  The maximum number of records to be displayed on a page.
• name: string
  The name of the deposit specification.
• permitted: string
  The purchase level permitted for the deposit specification. This can be a single service (for example, /service/email), all services (/service), all accounts (/account), or all accounts and services (*).
• profileName: string
  The name of the deposit specification profile.
• profileRef: string
  The deposit specification profile ID, for example: 0.0.0.1+-config-deposit_spec_profile+1234567
• status: string
  The deposit specifiction status, for example: DRAFT

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The deposit specifications were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepositSpec"
    }
}

Nested Schema : schema

Type: object

Show Source

• amount: object Money
• billPreference: integer (int32)
  The bill preference for the deposit specification. Allowed Values:

  • 0 (Immediate)
  • 1 (Auto-align)
• category(required): string
  The deposit specification category.
• chargeOfferRef(required): string
  The charge offer reference for the deposit specification.
• code(required): string
  The deposit specification code type.
• createdAt(required): string
  The date when the deposit specification is created.
• creditLimitFlag: boolean
  Default Value: false

  Specify whether to increase the customer credit limit by the deposit amount (true) or not (false).
• descr(required): string
  The deposit specification description.
• expiresAt(required): string
  The expiry date of the deposit specfication.
• glCode(required): string
  The general ledger ID.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The deposit specification ID.
• modifiedAt(required): string
  The date when the deposit specification is modified.
• name(required): string
  The deposit specification name.
• permitted(required): string
  Specify whether the deposit specification is permitted (true) or not (false).
• profileRef(required): string
  The deposit specification profile reference.
• startsAt(required): string
  The date when the deposit specification starts.
• status: integer (int32)
  The deposit specification status. Allowed Values: 0 (Active), 1 (Draft), 2 (Canceled).

{
    "required":[
        "category",
        "chargeOfferRef",
        "code",
        "createdAt",
        "descr",
        "expiresAt",
        "glCode",
        "href",
        "id",
        "modifiedAt",
        "name",
        "permitted",
        "profileRef",
        "startsAt"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit specification ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "startsAt":{
            "type":"string",
            "description":"The date when the deposit specification starts."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit specification is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit specification is modified."
        },
        "expiresAt":{
            "type":"string",
            "description":"The expiry date of the deposit specfication."
        },
        "category":{
            "type":"string",
            "description":"The deposit specification category."
        },
        "permitted":{
            "type":"string",
            "description":"Specify whether the deposit specification is permitted (<b>true</b>) or not (<b>false</b>)."
        },
        "code":{
            "type":"string",
            "description":"The deposit specification code type."
        },
        "name":{
            "type":"string",
            "description":"The deposit specification name."
        },
        "descr":{
            "type":"string",
            "description":"The deposit specification description."
        },
        "status":{
            "type":"integer",
            "description":"The deposit specification status. Allowed Values: <b>0</b> (Active), <b>1</b> (Draft), <b>2</b> (Canceled).",
            "format":"int32"
        },
        "profileRef":{
            "type":"string",
            "description":"The deposit specification profile reference."
        },
        "chargeOfferRef":{
            "type":"string",
            "description":"The charge offer reference for the deposit specification."
        },
        "billPreference":{
            "type":"integer",
            "description":"The bill preference for the deposit specification. Allowed Values: <ul><li><b>0</b> (Immediate)</li><li><b>1</b> (Auto-align)</li></ul>",
            "format":"int32"
        },
        "creditLimitFlag":{
            "type":"boolean",
            "description":"Specify whether to increase the customer credit limit by the deposit amount (true) or not (false).",
            "default":false
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        }
    },
    "xml":{
        "name":"depositSpec"
    }
}

Nested Schema : Money

Type: object

Show Source

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get active deposit specifications that match certain criteria 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/depositManagement/depositSpec?name=DepositSpecification*&status=ACTIVE&permitted=/account&profileRef=0.0.0.1+-config-deposit_spec_profile+2927482'

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.

[
 {
    "id": "0.0.0.1+-deposit_specification+2641457",
    "href": "http://hostname:port/bcws/webresources/version/depositManagement/depositSpec/0.0.0.1+-deposit_specification+2641457",
    "createdAt": "2021-11-06T12:39:57.000Z",
    "modifiedAt": "2021-11-06T12:39:57.000Z",
    "expiresAt": "2022-09-24T18:29:59.000Z",
    "category": "/account",
    "permitted": "/account",
    "code": "Deposit Specification Code",
    "name": "Deposit Specification Example",
    "descr": "Deposit Specification Example",
    "status": "ACTIVE",
    "profileRef": "0.0.0.1+-config-deposit_spec_profile+2927482",
    "chargeOfferRef": "0.0.0.1+-product+2750007",
    "billPreference": "IMMEDIATE",
    "creditLimitFlag": true
 },
 {
    "id": "0.0.0.1+-deposit_specification+2641457",
    "href": "http://hostname:port/bcws/webresources/version/depositManagement/depositSpec/0.0.0.1+-deposit_specification+2641457",
    "createdAt": "2021-11-06T12:39:57.000Z",
    "modifiedAt": "2021-11-06T12:44:34.000Z",
    "expiresAt": "2022-09-24T18:29:59.000Z",
    "category": "/account",
    "permitted": "/account",
    "code": "Deposit Specification Code",
    "name": "Deposit Specification Updated",
    "descr": "Deposit Specification Updated",
    "status": "ACTIVE",
    "profileRef": "0.0.0.1+-config-deposit_spec_profile+2927482",
    "chargeOfferRef": "0.0.0.1+-product+2750007",
    "billPreference": "IMMEDIATE",
    "creditLimitFlag": true
 }
]

Back to Top