Get Collections Group Details for an Account
get
/bcws/webresources/v1.0/collections/group/account/{id}
Gets the collections group information for all bill units that match the specified account ID.
Request
Path Parameters
-
id(required): string
The ID of the account to get collections group details for.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The collections group details were returned successfully.
Root Schema : collectionsGroupDetails
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
groupMembers: array
groupMembers
Details about the members of a collections sharing group.
-
groupOwners: array
groupOwners
A collections sharing group owner.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : groupMembers
Type:
array
Details about the members of a collections sharing group.
Show Source
-
Array of:
object GroupMembers
Details about the members of a collections sharing group.
Nested Schema : groupOwners
Type:
array
A collections sharing group owner.
Show Source
-
Array of:
object GroupOwners
A collections sharing group owner.
Nested Schema : GroupMembers
Type:
object
Details about the members of a collections sharing group.
Show Source
-
billUnitName: string
The name of the bill associated with the collections sharing group.
-
billUnitRef: object
ResourceRef
-
groupName: string
The name of the sharing group.
-
parentAccountNumber: string
The account number associated with the parent bill unit of the collections sharing group.
-
parentAccountRef: object
ResourceRef
-
parentBillUnitName: string
The name of the parent bill unit associated with the collections sharing group.
-
parentBillUnitRef: object
ResourceRef
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : GroupOwners
Type:
object
A collections sharing group owner.
Show Source
-
billUnitName: string
The name of the bill unit associated with the collections sharing group.
-
billUnitRef: object
ResourceRef
-
groupName: string
The name of the collections sharing group.
-
groupRef: object
ResourceRef
-
memberCount: integer
(int32)
The number of members in the collections sharing group.
500 Response
An internal server error occurred.
Examples
This example shows how to get the details of an account's collections 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/collections/group/account/0.0.0.1+-account+85712'
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,
"groupOwners": [
{
"groupRef": {
"id": "0.0.0.1+-group-collections_targets+257211",
"uri": ""
},
"groupName": "Collections Group 1",
"billUnitRef": {
"id": "0.0.0.1+-billinfo+148374",
"uri": ""
},
"billUnitName": "Bill Unit 2",
"memberCount": 0
}
],
"groupMembers": [
{
"groupName": "Collections Group 2",
"billUnitRef": {
"id": "0.0.0.1+-billinfo+82384",
"uri": ""
},
"billUnitName": "Bill Unit(1)",
"parentBillUnitRef": {
"id": "0.0.0.1+-billinfo+62901",
"uri": ""
},
"parentBillUnitName": "Bill Unit(1)",
"parentAccountRef": {
"id": "0.0.0.1+-account+65205",
"uri": ""
},
"parentAccountNumber": "0.0.0.1-65205"
}
]
}