Get Sharing Group Member Types

get

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

Gets all of the unique member types present in a sharing group members list.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The list of member types was returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : sponsor
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ResourceRef
Type: object
Show Source

500 Response

An internal server error occurred.
Back to Top

Examples

Example 1: A Sharing Group ID with Members of Different Types

This example shows how to get member types for the provided sharing group ID with members of different types 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/0.0.0.1+-group-sharing-charges+310300/members/types'

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

If successful, the response code 200 is returned with the following response body in JSON format.

[
    "/account",
    "/service/ip",
    "/service/email"
] 

Example 2: A Sharing Group ID that Contains Just Account Members (Non-Service Members)

This example shows how to get member types for the provided sharing group ID that contains just account members (non-service members) 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/0.0.0.1+-group-sharing-charges+531764/members/types'

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

If successful, the response code 200 is returned with the following response body in JSON format.

[    
"/account"
] 

Example 3: A Sharing Group ID that isn't in a Poid Format

This example shows how to get member types for the provided sharing group ID that isn't in a poid format 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/abc/members/types'

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

The following response body shows a response code 400 for an invalid sharing ID in JSON format.

{
"extension": null,    
"errorCode": 30016,    
"errorMessage": "Invalid Sharing Group ID",    
"isValidationError": false,    
"paramInfo": []
}
Back to Top