Examples - Instruction notification service Introducer Supplier

Get instructions with notifications

This example should be called regularly (e.g. for Introducers every hour or every day) depending on needs.

@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER

###
GET {{host}}/instructions/notifications
Authorization: Basic {{auth}}

The results for this will give you a list of instructions which have notifications. It will give you the tmpReference of these instructions along with your own reference.

As well as the references it will give you a lastCreatedTimestamp which you then use to mark the notifications as processed.

Get the notifications for an instruction

This example shows a call to retrieve the notifications for an instruction. It should be called based on the return from the call above.

@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER
@tmpReference=TMP123456

###
GET {{host}}/instruction/{{tmpReference}}/notifications
Authorization: Basic {{auth}}

Mark notifications as processed

Once you have processed the notifications from the call above you should mark them as processed. You will need the lastCreatedTimestamp from the call to get notifications for the instruction.

@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER
@tmpReference=TMP123456

###
GET {{host}}/instruction/{{tmpReference}}/notifications?timestamp=2025-02-19T15:22:12.2963802Z
Authorization: Basic {{auth}}

Reset notifications

If you wish you can reset notifications for an instruction.

@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER
@tmpReference=TMP123456

###
GET {{host}}/instruction/{{tmpReference}}/notifications?timestamp=0001-01-01T00:00:00.000000Z
Authorization: Basic {{auth}}