Request

GET /notifications

Parameters

Name	Type	Required	Description

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

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

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"
                }
            ]
    }
  ]
}

MAGDA Gebruikersomgeving

GET notifications

Request

Parameters

Response

Examples

Related pages

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid