Update a Collections Group
put
/bcws/webresources/v1.0/collections/group/{id}
Updates the collections group that matches the specified ID.
You can optionally do this:
- Replace the existing set of members
- Change the name of the collections group
- Change the parent bill unit
Request
Path Parameters
-
id(required): string
The ID of the collections group to update.
Supported Media Types
- application/xml
- application/json
Details about the collections group update.
Root Schema : schema
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
members: array
members
The list of members in the collections sharing group.
-
name: string
The name of the collections sharing group.
-
newParentBillUnitRef: object
ResourceRef
-
notes: object
Notes
-
parentBillUnitDue: number
The amount owed by the collections sharing group owner.
-
parentBillUnitRef: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : members
Type:
array
The list of members in the collections sharing group.
Show Source
-
Array of:
object Members
The list of members in the sharing group.
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 : Notes
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
Nested Schema : Members
Type:
object
The list of members in the sharing group.
Show Source
-
index: integer
(int32)
The position of the service in the index. For example, the first item in a list would have an index value of 1.
-
markAsDelete: boolean
Whether the service referenced is being deleted (true) or added (false) to the sharing group.
-
serviceRef: object
ResourceRef
Nested Schema : comments
Type:
array
The list of comments associated with the note.
Show Source
-
Array of:
object Comments
The list of comments associated with the note.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Comments
Type:
object
The list of comments associated with the note.
Show Source
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Details about the collections group update.
Root Schema : schema
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
members: array
members
The list of members in the collections sharing group.
-
name: string
The name of the collections sharing group.
-
newParentBillUnitRef: object
ResourceRef
-
notes: object
Notes
-
parentBillUnitDue: number
The amount owed by the collections sharing group owner.
-
parentBillUnitRef: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : members
Type:
array
The list of members in the collections sharing group.
Show Source
-
Array of:
object Members
The list of members in the sharing group.
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 : Notes
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
Nested Schema : Members
Type:
object
The list of members in the sharing group.
Show Source
-
index: integer
(int32)
The position of the service in the index. For example, the first item in a list would have an index value of 1.
-
markAsDelete: boolean
Whether the service referenced is being deleted (true) or added (false) to the sharing group.
-
serviceRef: object
ResourceRef
Nested Schema : comments
Type:
array
The list of comments associated with the note.
Show Source
-
Array of:
object Comments
The list of comments associated with the note.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Comments
Type:
object
The list of comments associated with the note.
Show Source
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Response
200 Response
The collections group was updated successfully.
500 Response
An internal server error occurred.
Examples
This example shows how to update a collections group name by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X PUT 'http://hostname:port/bcws/webresources/version/collections/group/0.0.0.1+-group-collections_targets+168355' -H 'content-type: application/json' -d @updateCollectionsGroup.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.
- updateCollectionsGroup.json is the JSON file that specifies the details to update.
Example of Request Body
This example shows the contents of the updateCollectionsGroup.json file sent as the request body.
{
"parentBillUnitRef": {
"id": "0.0.0.1+-billinfo+139726",
"uri": null
},
"name": "Collections Group 3a"
}
Example of Response Body
If successful, the response code 200 is returned with no response body.