Get All Packages
get
/bcws/webresources/v1.0/depositManagement/packages
Gets all packages.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The packages were returned successfully.
Nested Schema : plan
Type:
Show Source
object
-
code(required): string
The plan's code.
-
createdAt(required): string
The date the plan was created.
-
desc(required): string
The plan's description.
-
id(required): string
The plan's ID.
-
name(required): string
The plan's name.
500 Response
An error occurred. An exception has been raised.
Examples
This example shows how to get all packages for installments and deposits 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/packages'
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+-plan+125109",
"createdAt": "2021-09-16T11:38:22.000Z",
"name": "TestPackage_01",
"code": "8d3fabf8-81cc-4da7-9dd6-eb901b65e545",
"desc": "TestPackage_01"
},
{
"id": "0.0.0.1+-plan+126133",
"createdAt": "2021-09-16T11:38:22.000Z",
"name": "Deposit-Plan",
"code": "deposit_plan",
"desc": "Deposit-Plan"
},
{
"id": "0.0.0.1+-plan+125621",
"createdAt": "2021-09-16T11:38:22.000Z",
"name": "Installment-Plan",
"code": "installment_plan",
"desc": "Installment-Plan"
}
]