REST API Reference for Billing Care

Get Notification Events

get

/bcws/webresources/v1.0/notificationManagement/notificationEvent

Gets the notification events that match the specified query criteria.

Request

Query Parameters

name(required): string

The name of the notificationevent, for example /event/customer/actginfo

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The notification event information was returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object notificationEvent

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

Nested Schema : notificationEvent

Type: object

Show Source

eventName(required): string

The notification event name.
eventType: string

The event type.
flags: integer (int32)
notifySearchLevel: integer (int32)
The level to search for the notification. Allowed Values:
- 1 (Own self)
- 2 (Account)
- 4 (Balance group)
- 8 (Service)
- 16 (Bill info)
opcode: integer (int32)

The policy opcode number.

{
    "required":[
        "eventName"
    ],
    "type":"object",
    "properties":{
        "flags":{
            "type":"integer",
            "format":"int32"
        },
        "eventName":{
            "type":"string",
            "description":"The notification event name."
        },
        "opcode":{
            "type":"integer",
            "description":"The policy opcode number.",
            "format":"int32"
        },
        "eventType":{
            "type":"string",
            "description":"The event type."
        },
        "notifySearchLevel":{
            "type":"integer",
            "description":"The level to search for the notification. Allowed Values: <ul><li><b>1</b> (Own self)</li><li><b>2</b> (Account)</li><li><b>4</b> (Balance group)</li><li><b>8</b> (Service)</li><li><b>16</b> (Bill info)</li></ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"notificationEvent"
    }
}

500 Response

An error occurred. An exception has been raised.

Examples

This example shows how to get all notification events 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/notificationManagement/notificationEvent'

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.

[
    {
        "eventName": "CustCreate"
    },
    {
        "eventName": "CustDelete"
    },
    {
        "eventName": "CustModify"
    }
 ]