REST API Reference for Billing Care

Remove Members from a Group

put

/bcws/webresources/v1.0/sharing/members/account/{id}

Removes one or more members from the specified 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 list of members in the sharing group to delete. The minimum required parameters are:

membership
orderedBalGroupRef

Root Schema : schema

Type: object

Show Source

extension: object extension

The extended attributes.
membership(required): array membership

The list of sharing groups that the member belongs to.
orderedBalGroupRef: object ResourceRef

{
    "required":[
        "membership"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "orderedBalGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "membership":{
            "type":"array",
            "description":"The list of sharing groups that the member belongs to.",
            "items":{
                "$ref":"#/components/schemas/Membership"
            }
        }
    },
    "xml":{
        "name":"sharingMember"
    }
}

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.

{
    "type":"array",
    "description":"The list of sharing groups that the member belongs to.",
    "items":{
        "$ref":"#/components/schemas/Membership"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"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

accountRef: object ResourceRef
groupRef: object ResourceRef
serviceRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "groupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "description":"The list of sharing groups that the member belongs to."
}

The list of members in the sharing group to delete. The minimum required parameters are:

membership
orderedBalGroupRef

Root Schema : schema

Type: object

Show Source

extension: object extension

The extended attributes.
membership(required): array membership

The list of sharing groups that the member belongs to.
orderedBalGroupRef: object ResourceRef

{
    "required":[
        "membership"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "orderedBalGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "membership":{
            "type":"array",
            "description":"The list of sharing groups that the member belongs to.",
            "items":{
                "$ref":"#/components/schemas/Membership"
            }
        }
    },
    "xml":{
        "name":"sharingMember"
    }
}

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.

{
    "type":"array",
    "description":"The list of sharing groups that the member belongs to.",
    "items":{
        "$ref":"#/components/schemas/Membership"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"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

accountRef: object ResourceRef
groupRef: object ResourceRef
serviceRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "groupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "description":"The list of sharing groups that the member belongs to."
}

Response

204 Response

The members were deleted successfully.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Examples

This example shows how to remove a member from a product sharing group 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/sharing/members/account/0.0.0.1+-group-sharing-products+473438?type=product -H 'content-type: application/json' -d @removeMemberFromSharingGroup.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.
removeMemberFromSharingGroup.json is the JSON file that specifies the update to make.

Example of Request Body

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

{
   "orderedBalGroupRef": null,
   "membership": [
      {
         "serviceRef": null,
         "groupRef": null,
         "accountRef": {
            "id": "0.0.0.2+-account+323490"
         }
      }
   ]
}

Example of Response Body

If successful, the response returns code 204 with no response body.