Jump to

• Request
• Response
• Examples

Get Exempted Bill Units

get

/bcws/webresources/v1.0/collections/exempt

Gets all bill units that are exempted from collections.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The exempted bill units were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object collectionsExemptedBillUnits

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

Nested Schema : collectionsExemptedBillUnits

Type: object

Show Source

• accountId: string
  The ID of the account.
• accountNumber: string
  The account number.
• billUnitId(required): string
  The ID of the bill unit.
• billUnitName: string
  The bill unit's name.
• extension: object extension
  The extended attributes.
• firstName: string
  The customer's first name.
• lastName: string
  The customer's last name.

{
    "required":[
        "billUnitId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit."
        },
        "accountId":{
            "type":"string",
            "description":"The ID of the account."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "firstName":{
            "type":"string",
            "description":"The customer's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The customer's last name."
        },
        "billUnitName":{
            "type":"string",
            "description":"The bill unit's name."
        }
    },
    "xml":{
        "name":"collectionsExemptedBillUnits"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the bill units that are exempted from collections 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/collections/exempt'

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, in which only one bill unit is exempt.

[
   {
      "extension": null,
      "billUnitId": "0.0.0.1+-billinfo+700404",
      "accountId": "0.0.0.1+-account+696820",
      "accountNumber": "0.0.0.1-696820",
      "firstName": "Sarah",
      "lastName": "Davis",
      "billUnitName": "Bill Unit(2)"
   }
]

Back to Top