Jump to

• Request
• Response
• Examples

Update Shared Services for a Member

put

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

Updates the shared services for a member in a sharing group.

Request

Path Parameters

• id(required): string
  The ID of the sharing group.

Query Parameters

• type: string
  The type of sharing group to which the member belongs: charge, discount, product, or profile.

Supported Media Types

• application/xml
• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountRef: object ResourceRef
• extension: object extension
  The extended attributes.
• members: array members
  The list of members in the sharing group.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "members":{
            "type":"array",
            "description":"The list of members in the sharing group.",
            "items":{
                "$ref":"#/components/schemas/Members"
            }
        }
    },
    "xml":{
        "name":"sharingMemberServiceDetails"
    }
}

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 : extension

Type: object

The extended attributes.

Nested Schema : members

Type: array

The list of members in the sharing group.

Show Source

• Array of: object Members
  The list of members in the sharing group.

{
    "type":"array",
    "description":"The list of members in the sharing group.",
    "items":{
        "$ref":"#/components/schemas/Members"
    }
}

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

{
    "type":"object",
    "properties":{
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "markAsDelete":{
            "type":"boolean",
            "description":"Whether the service referenced is being deleted (<b>true</b>) or added (<b>false</b>) to the sharing group."
        },
        "index":{
            "type":"integer",
            "description":"The position of the service in the index. For example, the first item in a list would have an <b>index</b> value of <b>1</b>.",
            "format":"int32"
        }
    },
    "description":"The list of members in the sharing group."
}

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountRef: object ResourceRef
• extension: object extension
  The extended attributes.
• members: array members
  The list of members in the sharing group.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "members":{
            "type":"array",
            "description":"The list of members in the sharing group.",
            "items":{
                "$ref":"#/components/schemas/Members"
            }
        }
    },
    "xml":{
        "name":"sharingMemberServiceDetails"
    }
}

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 : extension

Type: object

The extended attributes.

Nested Schema : members

Type: array

The list of members in the sharing group.

Show Source

• Array of: object Members
  The list of members in the sharing group.

{
    "type":"array",
    "description":"The list of members in the sharing group.",
    "items":{
        "$ref":"#/components/schemas/Members"
    }
}

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

{
    "type":"object",
    "properties":{
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "markAsDelete":{
            "type":"boolean",
            "description":"Whether the service referenced is being deleted (<b>true</b>) or added (<b>false</b>) to the sharing group."
        },
        "index":{
            "type":"integer",
            "description":"The position of the service in the index. For example, the first item in a list would have an <b>index</b> value of <b>1</b>.",
            "format":"int32"
        }
    },
    "description":"The list of members in the sharing group."
}

Back to Top

Response

200 Response

The shared services were updated successfully.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to add a new service to be shared in 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/0.0.0.2+-group-sharing-products+473438?type=product -H 'content-type: application/json' -d @updateSharedServices.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.
• updateSharedServices.json is the JSON file that specifies the update to make.

Example of Request Body

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

{
   "members": [
      {
         "serviceRef": {
            "id": "0.0.0.2+-service-ip+321762"
         },
         "markAsDelete": false,
         "index": -1
      }
   ],
   "accountRef": {
      "id": "0.0.0.2+-account+323490"
   }
}

Example of Response Body

If successful, the response returns code 200 set to true with no response body.

Back to Top