REST API Reference for Billing Care

Get Charge Offers

get

/bcws/webresources/v1.0/depositManagement/chargeOffer

Gets the charge offers that match the query parameters.

Request

Query Parameters

category(required): string

The category of the charge offer, for example /device.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The charge offers were returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object installmentChargeOffer

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

Nested Schema : installmentChargeOffer

Type: object

Show Source

code(required): string

The code for the charge offer.
createdAt(required): string

The date the charge offer was created.
descr(required): string

The description of the charge offer.
expiresAt(required): string

The date the charge offer expires.
id(required): string

The ID of the charge offer.
name(required): string

The name of the charge offer.
offerType: integer (int32)

The ID of the charge offer type.
permitted(required): string

Teh purchase level permitted for the charge offer.
startsAt(required): string

The date the charge offer starts.

{
    "required":[
        "code",
        "createdAt",
        "descr",
        "expiresAt",
        "id",
        "name",
        "permitted",
        "startsAt"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the charge offer."
        },
        "createdAt":{
            "type":"string",
            "description":"The date the charge offer was created."
        },
        "startsAt":{
            "type":"string",
            "description":"The date the charge offer starts."
        },
        "expiresAt":{
            "type":"string",
            "description":"The date the charge offer expires."
        },
        "name":{
            "type":"string",
            "description":"The name of the charge offer."
        },
        "code":{
            "type":"string",
            "description":"The code for the charge offer."
        },
        "descr":{
            "type":"string",
            "description":"The description of the charge offer."
        },
        "permitted":{
            "type":"string",
            "description":"Teh purchase level permitted for the charge offer."
        },
        "offerType":{
            "type":"integer",
            "description":"The ID of the charge offer type.",
            "format":"int32"
        }
    },
    "xml":{
        "name":"installmentChargeOffer"
    }
}

500 Response

An error occurred. An exception has been raised.

Examples

This example shows how to get deposit charge offers for a particular category 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/chargeOffer?category=/account'

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+-product+125525",
        "createdAt": "2021-09-16T11:38:20.000Z",
        "startsAt": "1970-01-01T00:00:00.000Z",
        "expiresAt": "1970-01-01T00:00:00.000Z",
        "name": "Deposit Charge Offer",
        "code": "Deposit Charge Offer",
        "descr": "Deposit Charge Offer",
        "permitted": "/account",
        "offerType": "ONGOING"
    },
    {
        "id": "0.0.0.1+-product+126677",
        "createdAt": "2021-09-16T11:38:20.000Z",
        "startsAt": "1970-01-01T00:00:00.000Z",
        "expiresAt": "2024-01-01T00:00:00.000Z",
        "name": "Deposit Charge Offer1",
        "code": "Deposit Charge Offer1",
        "descr": "Deposit Charge Offer1",
        "permitted": "/account",
        "offerType": "ONGOING"
    }
]