...
Message structure:
| Send | Retrieve |
|---|
| AlertRetrieve |
| Alerts can only be sent by the WMDA's central system | | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval |
|
| Expand |
|---|
| | Field | Details |
|---|
| originalMessage | | Expand |
|---|
| | Field | Details |
|---|
| level | string alert level. enums may change Enum:
Array [ 3 ] | | status | string check later Enum:
Array [ 2 ] | | message | string
maxLength: 1024
example: WMDA will do maintenance on SMC system on the weekend of 10 march |
|
| | metaInformation | Embedded Meta Block |
|
|
...
Message structure:
| Send | Retrieve |
|---|
| AlertUpdateRetrieve |
| Alert updates can only be sent by the WMDA's central system | | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval |
|
| Expand |
|---|
| | Field | Details |
|---|
| originalMessage | | Expand |
|---|
| | Field | Details |
|---|
| alertReferenceIdentifier | string($uuid) | | level | string alert level. enums may change Enum:
Array [ 3 ] | | status | string check later Enum:
Array [ 2 ] | | message | string
maxLength: 1024
example: WMDA will do maintenance on SMC system on the weekend of 10 march |
|
| | metaInformation | Embedded Meta Block |
|
|
...
The available messages endpoint is used for retrieving an array of messages that are ready to be downloaded. This information can then be used to retrieve the messages from their respective *retrieve endpoints.
Message structure:
| Send | Retrieve |
|---|
| availableMessages |
| N/A | | Expand |
|---|
| | No parameters specified |
| Expand |
|---|
| | Field | Details |
|---|
| totalMessages | integer
total sum of messages that are ready for retrieval
| | messageType | string the message type Enum:
Array [ 23 ] | | numberOfMessages | integer
number of messages that are ready for retrieval |
|
|