Jump to

• Request
• Response
• Examples

Get message types

get

{basePath}/notifications/discovery

The API is used to get a list of all the available MessageType Types.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of MessageType types

Body ()

Root Schema : schema

Type: object

Show Source

• items: array items
  Array of notification message types.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of notification message types.",
            "items":{
                "$ref":"#/definitions/MessageType"
            }
        }
    }
}

Nested Schema : items

Type: array

Array of notification message types.

Show Source

• Array of: object MessageType
  Information about the type of message.

{
    "type":"array",
    "description":"Array of notification message types.",
    "items":{
        "$ref":"#/definitions/MessageType"
    }
}

Nested Schema : MessageType

Type: object

Information about the type of message.

Show Source

• id(required): string
  Identifier of the message type [Source - POS] "CheckNotification", "OrganizationsNotification", "ConfigurationNotification" supports organization, property, and revenue center hierarchy level subscriptions. "EmployeesNotification" supports organization, and property hierarchy level subscriptions.

  Example: { "id":"CheckNotification" }

{
    "description":"Information about the type of message.",
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"Identifier of the message type [Source - POS] \"CheckNotification\", \"OrganizationsNotification\", \"ConfigurationNotification\" supports organization, property, and revenue center hierarchy level subscriptions.\n\"EmployeesNotification\" supports organization, and property hierarchy level subscriptions.\n",
            "type":"string",
            "example":{
                "id":"CheckNotification"
            }
        }
    }
}

404 Response

404 Requested resource not found

Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "id": "CheckNotification"
    },
    {
      "id": "ConfigurationNotification"
    }
  ]
}

Back to Top