Jump to

• Request
• Response
• Examples

Get Delivery Methods

get

/bcws/webresources/v1.0/notificationManagement/deliveryMethod

Gets the notification delivery methods that match the specified query criteria.

Request

Query Parameters

• expiresAt: string
  The delivery method expiry date, for example: 2037-09-18T18:30:00.000Z
• id: string
  The delivery method ID.
• limit: string
  The maximum number of records to be displayed on a page.
• name: string
  The delivery method name.
• skip: integer(int32)
  The number of records to skip before returning results.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The delivery method information was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object deliveryMethod

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

Nested Schema : deliveryMethod

Type: object

Show Source

• id(required): string
  The delivery method ID.
• name(required): string
  The delivery method name.
• status(required): string
  The delivery status. Allowed values: ACTIVE, INACTIVE

{
    "required":[
        "id",
        "name",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The delivery method ID."
        },
        "name":{
            "type":"string",
            "description":"The delivery method name."
        },
        "status":{
            "type":"string",
            "description":"The delivery status. Allowed values: ACTIVE, INACTIVE"
        }
    },
    "xml":{
        "name":"deliveryMethod"
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get all notification delivery methods 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/deliveryMethod'

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": "1",
        "name": "IVR",
        "status": "ACTIVE"
    },
    {
        "id": "2",
        "name": "SMS",
        "status": "ACTIVE"
    },
    {
        "id": "3",
        "name": "EMAIL",
        "status": "ACTIVE"
    },
    {
        "id": "4",
        "name": "Twitter",
        "status": "ACTIVE"
    }
]

Back to Top