Jump to

• Request
• Response
• Examples

Get Notification Specifications

get

/bcws/webresources/v1.0/notificationManagement/notificationSpec

Gets the notification specifications that match the specified query criteria.

Request

Query Parameters

• aggregateMode: string
  The aggregate mode of the notification.
• category : string
  The notification specification category.
• deliveryMethod: string
  The delivery method of the event, for example: SMS
• expiresAt: string
  The notification specification expiry date, for example: 2037-09-18T18:30:00.000Z
• limit: string
  The maximum number of records to be displayed on a page.
• name: string
  The notification specification name.
• optType: string
  The opt-in/opt-out type of the notification.
• scope: string
  The notification specification trigger type.
  Allowed values are: [ "USER", "SYSTEM", "ALL" ]
• skip: string
  The number of records to skip before returning results.
• status: string
  The notification specifiction status, for example: DRAFT
• systemEvent: string
  The event type.
• triggerType: string
  The notification specification trigger type.
  Allowed values are: [ "AUTO", "SYSTEM", "ALL" ]
• type: string
  The notification specification type.
  Allowed values are: [ "ADVANCE", "REALTIME", "PREDEFINED", "FIRST_TRANSACTION" , "POSTDUE" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The notification specification information was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object notificationSpec

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

Nested Schema : notificationSpec

Type: object

Show Source

• advanceNotifications(required): array advanceNotifications
• aggregateMode: integer (int32)
  Aggregation mode. Allowed Values: 0 (Send multiple notifications), 1 (Send consolidated single notification with details from all).
• category(required): string
  Free text. Use this field for classification.
• createdAt(required): string
  The creation date for the notification specification.
• criteria(required): array criteria
• deliveryControlFlag: integer (int32)
  The notification control flag type. Allowed Values:

  • 0 (Always Deliver)
  • 1 (No delivery in silent period)
• deliveryMethods(required): array deliveryMethods
• deliverySpec(required): array deliverySpec
• descr(required): string
  The notification specification description.
• expiresAt(required): string
  The date when the notification specification expires.
• href(required): string
  The unique resource URL, used to get the notification specification object.
• id(required): string
  The notification specification ID.
• modifiedAt(required): string
  The modification date for the notification specification.
• name(required): string
  The notification specification name.
• optType: integer (int32)
  The notification Opt In/Opt Out options. Allowed Values:

  • 1 (Requires opt in)
  • 2 (Requires opt out)
  • 3 (Mandatory)
• scope: integer (int32)
  The notification scope. Allowed Values:

  • 1 (System)
  • 2 (User)
• startsAt(required): string
  The start date for the notification specification.
• status(required): string
  The notification specification status. Allowed values: ACTIVE, INACTIVE, EXPIRED
• systemEvent(required): string
  The notification event POID type.
• triggerType: integer (int32)
  The notification trigger type. Allowed Values:

  • 0 (All)
  • 1 (System)
  • 2 (Auto)
• type: integer (int32)
  The notification type. Allowed Values:

  • 1 (Advance)
  • 2 (Real-time)
  • 3 (Predefined)
  • 4 (First transaction)
  • 5 (Post-due)

{
    "required":[
        "advanceNotifications",
        "category",
        "createdAt",
        "criteria",
        "deliveryMethods",
        "deliverySpec",
        "descr",
        "expiresAt",
        "href",
        "id",
        "modifiedAt",
        "name",
        "startsAt",
        "status",
        "systemEvent"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The notification specification ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the notification specification object."
        },
        "createdAt":{
            "type":"string",
            "description":"The creation date for the notification specification."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The modification date for the notification specification."
        },
        "startsAt":{
            "type":"string",
            "description":"The start date for the notification specification."
        },
        "status":{
            "type":"string",
            "description":"The notification specification status. Allowed values: ACTIVE, INACTIVE, EXPIRED"
        },
        "category":{
            "type":"string",
            "description":"Free text. Use this field for classification."
        },
        "name":{
            "type":"string",
            "description":"The notification specification name."
        },
        "expiresAt":{
            "type":"string",
            "description":"The date when the notification specification expires."
        },
        "optType":{
            "type":"integer",
            "description":"The notification Opt In/Opt Out options. Allowed Values: <ul><li><b>1</b> (Requires opt in)</li><li><b>2</b> (Requires opt out)</li><li><b>3</b> (Mandatory)</li></ul>",
            "format":"int32"
        },
        "aggregateMode":{
            "type":"integer",
            "description":"Aggregation mode. Allowed Values: <b>0</b> (Send multiple notifications), <b>1</b> (Send consolidated single notification with details from all).",
            "format":"int32"
        },
        "deliveryControlFlag":{
            "type":"integer",
            "description":"The notification control flag type. Allowed Values: <ul><li><b>0</b> (Always Deliver)</li><li><b>1</b> (No delivery in silent period)</li></ul>",
            "format":"int32"
        },
        "descr":{
            "type":"string",
            "description":"The notification specification description."
        },
        "scope":{
            "type":"integer",
            "description":"The notification scope. Allowed Values: <ul><li><b>1</b> (System)</li><li><b>2</b> (User)</li></ul>",
            "format":"int32"
        },
        "type":{
            "type":"integer",
            "description":"The notification type. Allowed Values: <ul><li><b>1</b> (Advance)</li><li><b>2</b> (Real-time)</li><li><b>3</b> (Predefined)</li><li><b>4</b> (First transaction)</li><li><b>5</b> (Post-due)</li></ul>",
            "format":"int32"
        },
        "systemEvent":{
            "type":"string",
            "description":"The notification event POID type."
        },
        "criteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationCriteria"
            }
        },
        "deliverySpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationDeliverySpec"
            }
        },
        "advanceNotifications":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationDeliverySchedule"
            }
        },
        "deliveryMethods":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationDeliveryMethod"
            }
        },
        "triggerType":{
            "type":"integer",
            "description":"The notification trigger type. Allowed Values: <ul><li><b>0</b> (All)</li><li><b>1</b> (System)</li><li><b>2</b> (Auto)</li></ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"notificationSpec"
    }
}

Nested Schema : advanceNotifications

Type: array

Show Source

• Array of: object NotificationDeliverySchedule

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

Nested Schema : criteria

Type: array

Show Source

• Array of: object NotificationCriteria

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

Nested Schema : deliveryMethods

Type: array

Show Source

• Array of: object NotificationDeliveryMethod

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

Nested Schema : deliverySpec

Type: array

Show Source

• Array of: object NotificationDeliverySpec

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

Nested Schema : NotificationDeliverySchedule

Type: object

Show Source

• offsetUnit: integer (int32)
  The notification delivery schedule offset type. Allowed values:

  • 1 (Minute)
  • 3 (Hour)
  • 4 (Day)
  • 5 (Week)
  • 2 (Month)
  • 0 (Year)
• offsetValue(required): string
  The notification delivery schedule offset value.

{
    "required":[
        "offsetValue"
    ],
    "type":"object",
    "properties":{
        "offsetUnit":{
            "type":"integer",
            "description":"The notification delivery schedule offset type. Allowed values:<ul><li><b>1</b> (Minute)</li><li><b>3</b> (Hour)</li><li><b>4</b> (Day)</li><li><b>5</b> (Week)</li><li><b>2</b> (Month)</li><li><b>0</b> (Year)</li></ul>",
            "format":"int32"
        },
        "offsetValue":{
            "type":"string",
            "description":"The notification delivery schedule offset value."
        }
    }
}

Nested Schema : NotificationCriteria

Type: object

Show Source

• dataType: integer (int32)
  The notification data type.The notification criteria data type. Allowed Values:

  • 1 (Integer)
  • 3 (Enumeration)
  • 5 (String)
  • 7 (POID)
  • 8 (Timestamp)
  • 14 (Decimal)
• key(required): string
  The notification criteria key.
• operator: integer (int32)
  The operator for the qualifier. Allowed values:

  • 0 (Equals)
  • 1 (Less than)
  • 2 (Greater than)
  • 3 (Less than or equals)
  • 4 (Greater than or equals)
  • 5 (Not equal)
  • 6 (Contained in string)
  • 7 (Like)
• value(required): string
  The notification criteria value.

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "dataType":{
            "type":"integer",
            "description":"The notification data type.The notification criteria data type. Allowed Values: <ul><li><b>1</b> (Integer)</li><li><b>3</b> (Enumeration)</li><li><b>5</b> (String)</li><li><b>7</b> (POID)</li><li><b>8</b> (Timestamp)</li><li><b>14</b> (Decimal)</li></ul>",
            "format":"int32"
        },
        "value":{
            "type":"string",
            "description":"The notification criteria value."
        },
        "key":{
            "type":"string",
            "description":"The notification criteria key."
        },
        "operator":{
            "type":"integer",
            "description":"The operator for the qualifier. Allowed values:<ul><li><b>0</b> (Equals)</li><li><b>1</b> (Less than)</li><li><b>2</b> (Greater than)</li><li><b>3</b> (Less than or equals)</li><li><b>4</b> (Greater than or equals)</li><li><b>5</b> (Not equal)</li><li><b>6</b> (Contained in string)</li><li><b>7</b> (Like)</li></ul>",
            "format":"int32"
        }
    }
}

Nested Schema : NotificationDeliveryMethod

Type: object

Show Source

• id(required): string
  The notification delivery method ID.
• name(required): string
  The notification delivery method name.
• status: integer (int32)
  The notification delivery method status. Allowed Values:

  • 1 (Active)
  • 2 (Inactive)

{
    "required":[
        "id",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The notification delivery method name."
        },
        "id":{
            "type":"string",
            "description":"The notification delivery method ID."
        },
        "status":{
            "type":"integer",
            "description":"The notification delivery method status. Allowed Values: <ul><li><b>1</b> (Active)</li><li><b>2</b> (Inactive)</li></ul>",
            "format":"int32"
        }
    }
}

Nested Schema : NotificationDeliverySpec

Type: object

Show Source

• dayOfMonth: integer (int32)
  The day of the month.
• dayOfWeek: integer (int32)
  The day of the week.
• deliveryPeriodEnd(required): string
  The notification delivery end time. Pattern: ^([0-1]?\d|2[0-3])(?::([0-5]?\d))?(?::([0-5]?\d))?$

{
    "required":[
        "deliveryPeriodEnd"
    ],
    "type":"object",
    "properties":{
        "deliveryPeriodEnd":{
            "type":"string",
            "description":"The notification delivery end time. Pattern: ^([0-1]?\\d|2[0-3])(?::([0-5]?\\d))?(?::([0-5]?\\d))?$"
        },
        "dayOfWeek":{
            "type":"integer",
            "description":"The day of the week.",
            "format":"int32"
        },
        "dayOfMonth":{
            "type":"integer",
            "description":"The day of the month.",
            "format":"int32"
        }
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get notification specifications by status, name, and delivery method 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/notificationSpec?status=ACTIVE&name=NewNotificationSpec&deliveryMethod=SMS'

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.

[
    {
        "id": "0.0.0.1+-config-notification_spec+2394302",
        "href": "http://hostname:port/bcws/webresources/version/notificationSpec/0.0.0.1+-config-notification_spec+2394302",
        "createdAt": "2021-10-12T05:17:08.000Z",
        "modifiedAt": "2021-10-12T05:17:08.000Z",
        "startsAt": "2021-09-15T09:28:00.000Z",
        "expiresAt": "2022-10-28T18:29:59.000Z",
        "name": "NewNotificationSpec",
        "descr": "descr",
        "deliveryControlFlag": "UNSUPPRESS",
        "systemEvent": "NewNotificationSpec",
        "type": "ALL",
        "triggerType": "SYSTEM",
        "scope": "USER",
        "criteria": [
            {
                "key": "/account.ACCOUNT_NO",
                "value": "qre",
                "operator": "EQ",
                "dataType": "STR"
            }
        ],
        "deliveryMethods": [
            {
                "id": "1",
                "name": "SMS",
                "status": "ACTIVE"
            }
        ],
        "deliverySpec": [],
        "advanceNotifications": [
            {
                "offsetUnit": "MONTHS",
                "offsetValue": "1"
            }
        ]
    }
]

Back to Top