Request
GET /notifications
Parameters
Name | Type | Required | Description |
|---|---|---|---|
x-correlation-id | header | Y | ID of the transaction. Use this ID for log tracing and incident handling |
limit | query | N | How many results need to be returned |
offset | query | N | The first position to return from the results of the query. The default is 0, which starts the page at the first result. |
messageCorrelationId | query | N | message correlation id to query notifications for A single message id can be used to retreive information about 1 single notification |
status | query | N | The status(ses) of notifications to retrieve |
sentAfter | query | N | Retrieve notifications sent after |
sentBefore | query | N | Retrieve notifications sent before |
Response
Name | Required | Description | ||
|---|---|---|---|---|
totalAmount | Y | Total count of notifications (not considering paging pars: offset and limit) 0 when no notifications ap^ply to the criteria provided | ||
notifications | N | Collection, empty when no notifications found | ||
| id | Y |
| |
availableUntilDate | Y |
| ||
status | Y |
| ||
createdOn | Y |
| ||
updatedOn | N |
| ||
events | N | Collection, empty when no notification event found Selection criterium: | ||
| type | Y |
| |
action | N | The action that was taken by the receiver | ||
timestamp | Y |
| ||
