Jump to

• Request
• Response
• Examples

Get Ownership Details for an Account

get

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

Gets the ownership details for the specified account and sharing group type.

Both the id parameter and the type query parameter are required.

Request

Path Parameters

• id(required): string
  The ID of the account.

Query Parameters

• type: string
  The type of sharing group: charge, discount, product, or profile.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The ownership details were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object sharingOwnerDetails

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

Nested Schema : sharingOwnerDetails

Type: object

Show Source

• 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
  Whether this is a global charge sharing group (true) or not (false).
• 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.

{
    "required":[
        "billunitName",
        "groupName",
        "groupOwnerBalGroupName",
        "groupType",
        "paymentMethod"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "groupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "groupName":{
            "type":"string",
            "description":"The name of the sharing group."
        },
        "groupOwnerBalGroupref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "groupOwnerBalGroupName":{
            "type":"string",
            "description":"The name of the balance group owner."
        },
        "parentRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentName":{
            "type":"string",
            "description":"The parent's name."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billunitName":{
            "type":"string",
            "description":"The name of the bill unit associated with the sharing group."
        },
        "paymentMethod":{
            "type":"string",
            "description":"The payment method associated with the sharing group."
        },
        "memberCount":{
            "type":"integer",
            "description":"The number of members in the sharing group.",
            "format":"int32"
        },
        "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>"
        },
        "globalChargeShareGroup":{
            "type":"boolean",
            "description":"Whether this is a global charge sharing group (<b>true</b>) or not (<b>false</b>)."
        },
        "ownershipDetails":{
            "type":"array",
            "description":"The  ownership details for the sharing group.",
            "items":{
                "$ref":"#/components/schemas/OwnershipDetails"
            }
        }
    },
    "xml":{
        "name":"sharingOwnerDetails"
    }
}

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

{
    "type":"array",
    "description":"The  ownership details for the sharing group.",
    "items":{
        "$ref":"#/components/schemas/OwnershipDetails"
    }
}

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.

{
    "required":[
        "description",
        "name",
        "offeringRef",
        "quantity",
        "sharingRef",
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "sharingRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "offeringRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "quantity":{
            "type":"number",
            "description":"The quantity."
        },
        "index":{
            "type":"integer",
            "description":"The position of the entry in the index. For example, the first item in a list would have an (<b>index</b>) value of (<b>1</b>).",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The sharing group name."
        },
        "description":{
            "type":"string",
            "description":"The sharing group description."
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time the sharing group's validity starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the sharing group's validity ends.",
            "format":"date-time"
        }
    },
    "description":"The  ownership details for the sharing group."
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the details about discount sharing groups owned by an account 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+-account+221550?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": {
         "id": "0.0.0.1+-group-sharing-discounts+110486",
         "uri": null
      },
      "groupName": "VPNSharingGroup1",
      "groupOwnerBalGroupref": {
         "id": "0.0.0.1+-balance_group+61005",
         "uri": null
      },
      "groupOwnerBalGroupName": "Balance Group <Account>",
      "parentRef": {
         "id": "0.0.0.1+-account+59789",
         "uri": null
      },
      "parentName": null,
      "accountRef": null,
      "billunitName": null,
      "paymentMethod": null,
      "memberCount": 3,
      "groupType": "Sharing Discounts Group",
      "globalChargeShareGroup": false,
      "ownershipDetails": []
   }
]

Back to Top