1. REST API Reference for Billing Care
  2. Tasks
  3. Collections

Add a Member to a Collections Group

post

/bcws/webresources/v1.0/collections/group/member/{id}

Adds a member to an existing collections group.

Both the id parameter and the collectiongroupid query parameter are required.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - application/xml ()
The optional notes associated with the member added to the collections group.
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Request Body - application/json ()
The optional notes associated with the member added to the collections group.
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Back to Top

Response

200 Response

The member was added successfully.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to add a member to a collections group by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/version/collections/group/member/0.0.0.1+-billinfo+127416?collectiongroupid=0.0.0.1+-group-collections_targets+126162' -H 'content-type: application/json' -d @addCollectionsGroupMember.json

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.
  • addCollectionsGroupMember.json is the optional JSON file that specifies a note about adding the member.

Example of Request Body

This example shows the contents of the optional addCollectionsGroupMember.json file sent as the request body. Because a note ID is specified, the comment is added to an existing note. 

{
   "notes": {
      "billUnitId": "0.0.0.1+-billinfo+128084",
      "accountId": "0.0.0.1+-account+130964",
      "domainId": 0,
      "reasonId": 0,
      "type": 900,
      "subType": 901,
      "status": 101,
      "effectiveDate": "2021-02-08",
      "id": "0.0.0.1+-note+278620",
      "comments": [
         {
            "comment": "Adding to collections group."
         }
      ]
   }
}

Example of Response Body

If successful, the response code 200 is returned with no response body.

Back to Top