Add Members to a Group
post
/bcws/webresources/v1.0/sharing/members/{id}
Adds members to a sharing group.
Request
Path Parameters
-
id(required): string
The ID of the sharing group.
Query Parameters
-
type(required): string
The type of sharing group: charge, discount, product, or profile.
Supported Media Types
- application/xml
- application/json
The sharing group member details.
Root Schema : schema
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
membership(required): array
membership
The list of sharing groups that the member belongs to.
-
orderedBalGroupRef: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : membership
Type:
array
The list of sharing groups that the member belongs to.
Show Source
-
Array of:
object Membership
The list of sharing groups that the member belongs to.
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 : Membership
Type:
object
The list of sharing groups that the member belongs to.
Show Source
The sharing group member details.
Root Schema : schema
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
membership(required): array
membership
The list of sharing groups that the member belongs to.
-
orderedBalGroupRef: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : membership
Type:
array
The list of sharing groups that the member belongs to.
Show Source
-
Array of:
object Membership
The list of sharing groups that the member belongs to.
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 : Membership
Type:
object
The list of sharing groups that the member belongs to.
Show Source
Response
200 Response
The members were added successfully.
500 Response
An internal server error occurred.
Examples
This example shows how to add members to a product sharing group by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".
Note:
You can add accounts from multiple schemas to a sharing group if the CrossSchemaSharingGroup System business parameter is enabled.
cURL Command
curl -X POST http://hostname/bcws/webresources/version/sharing/members/0.0.0.1+-group-sharing-products+473438?type=product -H 'content-type: application/json' -d @addMembers.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.
- addMembers.json is the JSON file that specifies members to add.
Example of Request Body
This shows an example of the contents of the addMembers.json file sent as the request body.
{
"orderedBalGroupRef": null,
"membership": [
{
"serviceRef": {
"id": "0.0.0.1+-service-ip+321762"
},
"groupRef": null,
"accountRef": {
"id": "0.0.0.1+-account+323490"
}
},
{
"serviceRef": {
"id": "0.0.0.2+-service-ip+323562"
},
"groupRef": null,
"accountRef": {
"id": "0.0.0.2+-account+314390"
}
}
]
}
Example of Response Body
If successful, the response returns code 200 set to true with no response body.