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

Update Membership in Sharing Group

put

/bcws/webresources/v1.0/sharing/members/priority

Updates the list of members in the specified sharing group.

Request

Query Parameters
Supported Media Types
Request Body - application/json ()
The list of members in the sharing group. If a sharing member's ordered balance group is empty or null, a new ordered balance group will be created and members will be added. If present, the ordered balance group will be modified to add new members.
Root Schema : schema
Type: array
Show Source
Nested Schema : schema
Type: object
Show Source
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
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : Membership
Type: object
The list of sharing groups that the member belongs to.
Show Source
Request Body - application/xml ()
The list of members in the sharing group. If a sharing member's ordered balance group is empty or null, a new ordered balance group will be created and members will be added. If present, the ordered balance group will be modified to add new members.
Root Schema : schema
Type: array
Show Source
Nested Schema : schema
Type: object
Show Source
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
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : Membership
Type: object
The list of sharing groups that the member belongs to.
Show Source
Back to Top

Response

201 Response

The membership was updated successfully.

500 Response

An internal server error occurred.
Back to Top

Examples

Example Adding Members to Multiple Sharing Groups

This example shows how to add members to multiple sharing groups 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/v1.0/sharing/members/priority?type=charge -H 'content-type: application/json' -d @updateSharingGroup.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.
  • updateSharingGroup.json is the JSON file that specifies the update to make.

Example of Request Body

This example shows the contents of the updateSharingGroup.json file sent as the request body. 

[
   {
      "membership": [
         {
            "serviceRef": {
               "id": "0.0.0.1+-service-email+265928",
               "uri": null
            },
            "accountRef": {
               "id": "0.0.0.1+-account+181438",
               "uri":null
            },
            "groupRef": {
               "id": "0.0.0.1+-group-sharing-charges+271857",
               "uri": null
            }
         },
         {
            "serviceRef": {
               "id": "0.0.0.1+-service-email+265928",
               "uri":null
            },
            "accountRef": {
               "id": "0.0.0.1+-account+181438",
               "uri": null
            },
            "groupRef": {
               "id": "0.0.0.1+-group-sharing-charges+275842",
               "uri": null
            }
         }
      ],
      "orderedBalGroupRef": {
         "id": "0.0.0.1+-ordered_balgrp+276610",
         "uri": null
      }
   }
]

Example of Response Body

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

Example Modifying Membership Priority in Product Sharing Groups

This example shows how to modify membership priority in product sharing groups by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".

Note:

The sharing groups and ordered balance groups can belong to multiple schemas.

cURL Command

curl -X PUT http://hostname:port/bcws/webresources/version/sharing/members/priority?type=product -H 'content-type: application/json' -d @updateSharingGroup.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.
  • updateSharingGroup.json is the JSON file that specifies the update to make.

Example of Request Body

This example shows the contents of the updateSharingGroup.json file sent as the request body. 

[
   {
      "orderedBalGroupRef": {
         "id": "0.0.0.1+-ordered_balgrp+155130",
         "uri": null
      },
      "membership": [
         {
            "groupRef": {
               "id": "0.0.0.1+-group-sharing-products+155673",
               "uri": null
            }
         },
         {
            "groupRef": {
               "id": "0.0.0.2+-group-sharing-products+153467",
               "uri": null
            }
         }
      ]
   },
   {
      "orderedBalGroupRef": {
         "id": "0.0.0.2+-ordered_balgrp+155156",
         "uri": null
      },
      "membership": [
         {
            "groupRef": {
               "id": "0.0.0.1+-group-sharing-products+155667",
               "uri": null
            }
         },
         {
            "groupRef": {
               "id": "0.0.0.2+-group-sharing-products+153489",
               "uri": null
            }
         }
      ]
   }
]

Example of Response Body

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

Back to Top