Get Group Ownership Details
get
/bcws/webresources/v1.0/sharing/group/{id}
Gets the ownership details for the specified sharing group.
Both the id parameter and the type query parameter are required.
Request
Path Parameters
-
id(required): string
The ID of the sharing group.
Query Parameters
-
type(required): string
The type of sharing group: charge, discount, product, or profile.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The sharing group's ownership details were returned successfully.
Root Schema : sharingOwnerDetails
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
billunitName(required): string
The name of the bill unit associated with the sharing group.
-
extension: object
extension
The extended attributes.
- globalChargeShareGroup: boolean
-
groupName(required): string
The name of the sharing group.
-
groupOwnerBalGroupName(required): string
The name of the balance group owner.
-
groupOwnerBalGroupref: object
ResourceRef
-
groupRef: 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)
-
memberCount: integer
(int32)
The number of members in the sharing group.
-
ownershipDetails: array
ownershipDetails
The ownership details for the sharing group.
-
parentName: string
The parent's name.
-
parentRef: object
ResourceRef
-
paymentMethod(required): string
The payment method associated with the sharing group.
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 : extension
Type:
object
The extended attributes.
Nested Schema : ownershipDetails
Type:
array
The ownership details for the sharing group.
Show Source
-
Array of:
object OwnershipDetails
The ownership details for the sharing group.
Nested Schema : OwnershipDetails
Type:
object
The ownership details for the sharing group.
Show Source
-
description(required): string
The sharing group description.
-
index: integer
(int32)
The position of the entry in the index. For example, the first item in a list would have an (index) value of (1).
-
name(required): string
The sharing group name.
-
offeringRef(required): object
ResourceRef
-
quantity(required): number
The quantity.
-
sharingRef(required): object
ResourceRef
-
validFrom(required): string
(date-time)
The date and time the sharing group's validity starts.
-
validTo(required): string
(date-time)
The date and time the sharing group's validity ends.
500 Response
An internal server error occurred.
Examples
This example shows how to get the ownership details for a product 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/group/0.0.0.1+-group-sharing-products+260748?type=product'
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,
"groupName": "product-group-to-test-member-apis",
"groupOwnerBalGroupref": {
"id": "0.0.0.1+-balance_group+228328",
"uri": null
},
"groupOwnerBalGroupName": "Balance Group<account>",
"parentRef": {
"id": "0.0.0.1+-service-ip+225560",
"uri": null
},
"parentName": "654543333: ip",
"accountRef": {
"id": "0.0.0.1+-account+227048",
"uri": null
},
"billunitName": null,
"paymentMethod": null,
"memberCount": 0,
"globalChargeShareGroup": false,
"ownershipDetails": [
{
"sharingRef": {
"id": "0.0.0.1+-product+108708",
"uri": null
},
"offeringRef": null,
"quantity": null,
"index": 1,
"name": null,
"description": null,
"validFrom": null,
"validTo": null
}
]
}