Get Membership Details for an Account
get
/bcws/webresources/v1.0/sharing/membership/{id}
Gets membership details for an account that is a charge sharing group member or discount sharing group member.
Both the id parameter and type query parameter are required.
Request
Path Parameters
-
id(required): string
The account ID of the sharing group member.
Query Parameters
-
type(required): string
The type of sharing group to get: charge, discount, product, or profile.
This query parameter is required.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The membership details were returned successfully.
Nested Schema : sharingMemberDetails
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
groupref: object
ResourceRef
-
membershipDetails: array
membershipDetails
The list of groups the member belongs to.
-
orderedBalGroupref: object
ResourceRef
-
serviceRef: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : membershipDetails
Type:
array
The list of groups the member belongs to.
Show Source
-
Array of:
object MembershipDetails
The list of groups the member belongs to.
Nested Schema : MembershipDetails
Type:
object
The list of groups the member belongs to.
Show Source
-
accountNumber(required): string
The account number associated with the sharing group.
-
accountRef(required): object
ResourceRef
-
groupName(required): string
The sharing group's name.
-
groupRef(required): object
ResourceRef
-
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)
-
parentName: string
The sharing group parent's name.
-
priority: integer
(int32)
The priority.
-
serviceName(required): string
The name of the service being shared.
-
serviceRef(required): object
ResourceRef
500 Response
An internal server error occurred.
Examples
This example shows how to get the discount sharing groups that an account is a member of 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/membership/0.0.0.1+-account+97823?type=discount
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,
"groupref": null,
"orderedBalGroupref": {
"id": "0.0.0.1+-ordered_balgrp+215250",
"uri": null
},
"serviceRef": {
"id": "0.0.0.1+-service-ip+98207",
"uri": null
},
"membershipDetails": [
{
"groupRef": {
"id": "0.0.0.1+-group-sharing-discounts+-1",
"uri": null
},
"groupName": "My Owned Discounts",
"groupType": null,
"serviceRef": {
"id": "0.0.0.1+-service-ip+98207",
"uri": null
},
"serviceName": "ip111: ip",
"priority": 1,
"accountRef": {
"id": "0.0.0.1+-account+97823",
"uri": null
},
"accountNumber": "0.0.0.1-97823",
"parentName": null
},
{
"groupRef": {
"id": "0.0.0.1+-group-sharing-discounts+110486",
"uri": null
},
"groupName": "VPNSharingGroup1",
"groupType": "Sharing Discounts Group",
"serviceRef": {
"id": "0.0.0.1+-service-ip+98207",
"uri": null
},
"serviceName": "ip111: ip",
"priority": 2,
"accountRef": {
"id": "0.0.0.1+-account+59789",
"uri": null
},
"accountNumber": "0.0.0.1-59789",
"parentName": null
},
{
"groupRef": {
"id": "0.0.0.2+-group-sharing-discounts+53340",
"uri": null
},
"groupName": "SharingGroup2",
"groupType": "Sharing Discounts Group",
"serviceRef": {
"id": "0.0.0.2+-service-ip+41299",
"uri": null
},
"serviceName": "ip11: ip",
"priority": 3,
"accountRef": {
"id": "0.0.0.2+-account+41107",
"uri": null
},
"accountNumber": "0.0.0.2-41107",
"parentName": null
}
]
}
]