Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

 Actual status of the notification:

  • “CREATED”

  • “RECEIVED”

  • “OPENED”

  • “ACTION_TAKEN

createdOn

Y

 

updatedOn

N

 

events

N

Collection, empty when no notification event found

Selection criterium: Notification.id = NotificationEvent.notification_id

 

type

Y

 “CREATED”
“RECEIVED”
“OPENED”
“ACTION_TAKEN”

action

N

Only applicable for ACTION_TAKEN events.

The action that was taken by the receiver .

Filled with the value of the action field of the custom-action-button that was clicked within GovApp

timestamp

Y

 When the event was received

Examples

Code Block
GET /notifications?messageCorrelationId=corr_4

{
  "totalAmount": 1,
  "notifications": [
    {
            "id": "544b4fe0-f17f-4ef6-8c36-a533bd653c2b",
            "availableUntilDate": "2022-10-04T00:00:00Z",
            "status": "ACTION_TAKEN",
            "createdOn": "2022-09-29T07:38:49.523617Z",
            "updatedOn": "2022-09-29T08:02:14.000111Z",
            "events": [
                {
                    "type": "CREATED",
                    "timestamp": "2022-09-29T07:38:49.523617Z"
                },
                {
                    "type": "RECEIVED",
                    "timestamp": "2022-09-29T07:38:51.300364Z"
                },
                {
                    "type": "ACTION_TAKEN",
                    "action": "Accept"
                    "timestamp": "2022-09-29T08:02:14.000111Z"
                }
            ]
    }
  ]
}