Get Events

get

/bcws/webresources/v1.0/events

Gets the list of events that match the specified criteria.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The event information was returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : event
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : balanceImpacts
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : monitorImpacts
Type: array
Show Source
Nested Schema : monitorSubBalanceImpacts
Type: array
Show Source
Nested Schema : rumMap
Type: array
Show Source
Nested Schema : subBalanceImpacts
Type: array
Show Source
Nested Schema : taxJurisdictions
Type: array
Show Source
Nested Schema : BalanceImpact
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : MonitorImpact
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : SubBalanceImpact
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : subBalances
Type: array
Show Source
Nested Schema : EventSubBalances
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : RumMap
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : TaxJurisdiction
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.

204 Response

No search criteria were provided for the event search.

400 Response

The request is not valid.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get event details 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/events

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,
        "id": {
            "id": "0.0.0.1+-newsfeed+358845410934774345",
            "uri": null
        },
        "created": 1762419890000,
        "accountRef": {
            "id": "0.0.0.1+-account+384667",
            "uri": null
        },
        "amount": -0.002,
        "billInfoRef": {
            "id": "0.0.0.1+-billinfo+384411",
            "uri": null
        },
        "eventRef": {
            "id": "0.0.0.1+-event-billing-dispute-event+358845410934772297",
            "uri": null
        },
        "externalUser": "weblogic",
        "message": "120",
        "objectRef": {
            "id": "0.0.0.1+-item-dispute+358845410934774857",
            "uri": null
        },
        "reasonDomainId": 60,
        "reasonId": 107,
        "resourceId": 978,
        "typeId": 3,
        "typeStr": "D1-181"
    },
    {
        "extension": null,
        "id": {
            "id": "0.0.0.1+-newsfeed+358845410934775625",
            "uri": null
        },
        "created": 1762419973000,
        "accountRef": {
            "id": "0.0.0.1+-account+384667",
            "uri": null
        },
        "amount": 0,
        "billInfoRef": {
            "id": "0.0.0.1+-billinfo+384411",
            "uri": null
        },
        "eventRef": {
            "id": "0.0.0.1+-event-billing-settlement-event+358845410934773577",
            "uri": null
        },
        "externalUser": "weblogic",
        "message": "123;;126;;999|~|0.002;;999|~|D1-181",
        "objectRef": {
            "id": "0.0.0.1+-item-settlement+358845410934774601",
            "uri": null
        },
        "reasonDomainId": 60,
        "reasonId": 108,
        "resourceId": 978,
        "typeId": 4,
        "typeStr": ""
    }
]
Back to Top