Get Sharing Group Member Types
/bcws/webresources/v1.0/sharing/{id}/members/types
Request
-
id(required): string
The ID of the sharing group to get member types from.
There's no request body for this operation.
Back to TopResponse
- application/xml
- application/json
200 Response
object
-
description(required): string
The sponsored offer's description.
-
eventDescription(required): string
The description of the event associated with the sponsored offer.
-
eventType(required): string
The event type associated with the sponsored offer.
-
extension: object
extension
The extended attributes.
-
name(required): string
The name of the sharing group.
-
offeringRef: object
ResourceRef
-
quantity: string
The quantity of the sponsored offer in the sharing group.
-
rollupEnabledSponsor: boolean
Whether this is a rollup-enabled sponsor (true) or not (false).
-
selected: boolean
Whether the sponsored offer is selected (true) or not (false).
-
sponsorshipRef(required): object
ResourceRef
-
validFrom(required): string
(date-time)
The date and time the sponsored offer's validity starts.
-
validTo(required): string
(date-time)
The date and time the sponsored offer's validity ends.
object
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
500 Response
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": []
}