Jump to

• Request
• Response
• Examples

Get Charges Added to Sharing Groups

get

/bcws/webresources/v1.0/sharing/sponsors/charge

Gets a list of all charges that have been added to sharing groups across the system.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The list of sponsors was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object sponsor

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

Nested Schema : sponsor

Type: object

Show Source

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

{
    "required":[
        "description",
        "eventDescription",
        "eventType",
        "name",
        "sponsorshipRef",
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "sponsorshipRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "offeringRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the sharing group."
        },
        "quantity":{
            "type":"string",
            "description":"The quantity of the sponsored offer in the sharing group."
        },
        "description":{
            "type":"string",
            "description":"The sponsored offer's description."
        },
        "eventType":{
            "type":"string",
            "description":"The event type associated with the sponsored offer."
        },
        "eventDescription":{
            "type":"string",
            "description":"The description of the event associated with the sponsored offer."
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time the sponsored offer's validity starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the sponsored offer's validity ends.",
            "format":"date-time"
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the sponsored offer is selected (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "xml":{
        "name":"sponsor"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

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."
        }
    }
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get a list of charges that are shared in sharing groups 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/sponsors/charge'

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,
        "sponsorshipRef":{
            "id":"0.0.0.1+-sponsorship+225511",
            "uri":null
        },
        "offeringRef":null,
        "name":"Charge Share for Monthly Cycle FWD",
        "quantity":null,
        "description":"",
        "eventType":"/event/billing/product/fee/cycle/cycle_forward_monthly",
        "eventDescription":"Monthly Cycle Forward Event",
        "validFrom":0,
        "validTo":0,
        "selected":false
    },
    {
        "extension":null,
        "sponsorshipRef":{
            "id":"0.0.0.1+-sponsorship+198142",
            "uri":null
        },
        "offeringRef":null,
        "name":"Standard GSM Charge Share",
        "quantity":null,
        "description":"",
        "eventType":"/event/delayed/session/telco/gsm",
        "eventDescription":"Delayed Telco GSM Session",
        "validFrom":0,
        "validTo":0,
        "selected":false
    }
]

Back to Top