1. REST API Reference for Billing Care
  2. Tasks
  3. Notifications

Update a Notification Specification

patch

/bcws/webresources/v1.0/notificationManagement/notificationSpec/{id}

Updates the notification specification with the specified ID.

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
The notification specification to update. The minimum required parameters are:
  • name
Root Schema : schema
Type: object
Show Source
Nested Schema : advanceNotifications
Type: array
Show Source
Nested Schema : criteria
Type: array
Show Source
Nested Schema : deliveryMethods
Type: array
Show Source
Nested Schema : deliverySpec
Type: array
Show Source
Nested Schema : NotificationDeliverySchedule
Type: object
Show Source
Nested Schema : NotificationCriteria
Type: object
Show Source
Nested Schema : NotificationDeliveryMethod
Type: object
Show Source
Nested Schema : NotificationDeliverySpec
Type: object
Show Source
Request Body - application/json ()
The notification specification to update. The minimum required parameters are:
  • name
Root Schema : schema
Type: object
Show Source
Nested Schema : advanceNotifications
Type: array
Show Source
Nested Schema : criteria
Type: array
Show Source
Nested Schema : deliveryMethods
Type: array
Show Source
Nested Schema : deliverySpec
Type: array
Show Source
Nested Schema : NotificationDeliverySchedule
Type: object
Show Source
Nested Schema : NotificationCriteria
Type: object
Show Source
Nested Schema : NotificationDeliveryMethod
Type: object
Show Source
Nested Schema : NotificationDeliverySpec
Type: object
Show Source
Back to Top

Response

201 Response

The notification specification was updated successfully.

500 Response

An error occurred. An exception has been raised.
Back to Top

Examples

This example shows how to update a notification specification by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X PUT 'http://hostname:port/bcws/webresources/version/notificationManagement/notificationSpec /0.0.0.1+-config-notificationSpec+ 2865053' -H 'content-type: application/json' -d @updateNotificationSpec.json

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.
  • updateNotificationSpec.json is the JSON file that specifies the details to update.

Example of Request Body

This example shows the contents of the updateNotificationSpec.json file sent as the request body. 

[
    {
        "id": "0.0.0.1+-config-notification_spec+2865053",
        "startsAt": "2022-11-21T09:28:00.000Z",
        "expiresAt": "2023-10-28T18:29:59.000Z",
        "name": "New Notification",
        "descr": "descr updated",
        "deliveryControlFlag": "SUPPRESS",
        "systemEvent": "New Notification",
        "type": "REALTIME",
        "triggerType": "SYSTEM",
        "scope": "USER",
        "criteria": [
            {
                "key": "/account.ACCOUNT_NO",
                "value": "12345",
                "operator": "EQ",
                "dataType": "STR"
            }
        ],
        "deliveryMethods": [
            {
                "id": "3",
                "name": "EMAIL",
                "status": "ACTIVE"
            }
        ],
        "deliverySpec": [
            {
                "firstTransaction": "WEEKS",
                "deliveryPeriodEnd": "9:30",
                "dayOfMonth": 31,
                "dayOfWeek": 5
            }
        ],
        "advanceNotifications": [
            {
                "offsetUnit": "DAYS",
                "offsetValue": "3"
            }
        ]
    }
]

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "id": "0.0.0.1+-config-notification_spec+2865053",
    "href": "http://hostname:port/bcws/webresources/version/notificationSpec/0.0.0.1+-config-notification_spec+2865053"
}
Back to Top