Jump to

• Request
• Response
• Examples

Get Members of a Group

get

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

Gets the members of the sharing group that matches the specified ID.

Request

Path Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The members were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SharingGroupMembers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SharingGroupMembers"
    }
}

Nested Schema : SharingGroupMembers

Type: object

Show Source

• extension: object extension
  The extended attributes.
• groupType(required): string
  The sharing group type. Allowed Values:

  • H_PSG (Hierarchy product sharing group)
  • PR_PSG (Payment responsibility product sharing group)
  • H_DSG (Hierarchy discount sharing group)
  • PR_DSG (Payment responsibility discount sharing group)
• memberDetails: array memberDetails
  The list of sharing group members.

{
    "required":[
        "groupType"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "groupType":{
            "type":"string",
            "description":"The sharing group type. Allowed Values: <ul><li><b>H_PSG</b> (Hierarchy product sharing group)</li><li><b>PR_PSG</b> (Payment responsibility product sharing group)</li><li><b>H_DSG</b> (Hierarchy discount sharing group)</li><li><b>PR_DSG</b> (Payment responsibility discount sharing group)</li></ul>"
        },
        "memberDetails":{
            "type":"array",
            "description":"The list of sharing group members.",
            "items":{
                "$ref":"#/components/schemas/MemberDetails"
            }
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : memberDetails

Type: array

The list of sharing group members.

Show Source

• Array of: object MemberDetails
  The list of sharing group members.

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

Nested Schema : MemberDetails

Type: object

The list of sharing group members.

Show Source

• accountNumber: string
  The member's account number.
• accountRef: object ResourceRef
• firstName: string
  The member's first name.
• lastName: string
  The member's last name.
• services: array services
  The list of services shared in the group.

{
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "services":{
            "type":"array",
            "description":"The list of services shared in the group.",
            "items":{
                "$ref":"#/components/schemas/Services"
            }
        },
        "accountNumber":{
            "type":"string",
            "description":"The member's account number."
        },
        "firstName":{
            "type":"string",
            "description":"The member's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The member's last name."
        }
    },
    "description":"The list of sharing group members."
}

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

Type: array

The list of services shared in the group.

Show Source

• Array of: object Services
  The list of services shared in the group.

{
    "type":"array",
    "description":"The list of services shared in the group.",
    "items":{
        "$ref":"#/components/schemas/Services"
    }
}

Nested Schema : Services

Type: object

The list of services shared in the group.

Show Source

• index: integer (int32)
  The position of the entry in the index. For example, the first service in a list would have an index value of 1.
• serviceRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "index":{
            "type":"integer",
            "description":"The position of the entry in the index. For example, the first service in a list would have an <b>index</b> value of <b>1</b>.",
            "format":"int32"
        }
    },
    "description":"The list of services shared in the group."
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the members of a discount sharing group by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/sharing/members/0.0.0.1+-group-sharing-discounts+110486'

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.

Example of Response Body

This example shows the contents of the response body in JSON format.

{
   "extension": null,
   "groupType": "Sharing Discounts Group",
   "memberDetails": [
      {
         "accountRef": {
            "id": "0.0.0.1+-account+210954",
            "uri": null
         },
         "services": [
            {
               "serviceRef": {
                  "id": "0.0.0.0++0",
                  "uri": null
               },
               "index": 2
            }
         ],
         "accountNumber": "0.0.0.1-210954",
         "firstName": "Bob",
         "lastName": "Williams"
      },
      {
         "accountRef": {
            "id": "0.0.0.2+-account+41107",
            "uri": null
         },
         "services": [
            {
               "serviceRef": {
                  "id": "0.0.0.0++0",
                  "uri": null
               },
               "index": 1
            },
            {
               "serviceRef": {
                  "id": "0.0.0.2+-service-ip+41299",
                  "uri": null
               },
               "index": 3
            }
         ],
         "accountNumber": "0.0.0.2-41107",
         "firstName": "Joe",
         "lastName": "Ochoa"
      }
   ]
}

Back to Top