You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="govuk-body">Duplicate events will have the same <codeclass="app-code app-code--inline">event_datetime</code> field and <codeclass="app-code app-code--inline">notification_type</code> which can be used to locate and ignore duplicates when receiving notifications. Notifications will continue to be returned by the endpoint until they are acknowledged.</p>
<pclass="govuk-body">Once a notification has been processed by your system, the notification should be acknowledged. To do this, send a list of <codeclass="app-code app-code--inline">notification_ids</code> to the Acknowledge notifications API as a POST request. This will change the status of those notifications to <codeclass="app-code app-code--inline">ACKNOWLEDGED</code>.</p>
<tdclass="govuk-table__cell">An application is submitted, but mandatory fields are missing or incorrectly formatted. The system validates the input and rejects the application, triggering this notification
<tdclass="govuk-table__cell">An application submitted outside business hours passes initial validation, is accepted, and awaits addition to the Daylist
<tdclass="govuk-table__cell">There is an attempt to create an application, but a system-level error occurs. The application cannot be processed, and this notification is sent to alert the integrator
<tdclass="govuk-table__cell">A user uploads a required document to an application during processing. The system successfully attaches the file and sends this notification
<tdclass="govuk-table__cell">A user uploads an attachment, but the file fails validation due to issues such as incorrect format, corrupted file, or missing mandatory details. The system rejects the attachment and triggers this notification
<tdclass="govuk-table__cell">A message intended for the application fails validation because it violates formatting rules. The system rejects the message and sends this notification
"tokens": "how use notifications api recieve get request fetch all takes following url query parameters which are optional created after only retrieve with timestamp this date before status specific either new acknowledged occured event notification type subject additional provider filter that match provided limit maximum number return single response related applications submitted by business unit id will returned delivery least once meaning time may result one more e duplicate same events have datetime field can used locate ignore duplicates when receiving continue endpoint until they acknowledge been processed your system should send list ids post change those validation rules there implementing example requests responses examples payloads produced during application submission view submit v1 2025 01 01t00 00 http 1 copy code data 3fa85f64 5717 4562 b3fc 2c963f66afa6 03 06t14 32 55 295z payload schema https com string additionalprop1 additionalprop2 additionalprop3"
288
+
"tokens": "how use notifications api recieve get request fetch all takes following url query parameters which are optional created after only retrieve with timestamp this date before status specific either new acknowledged occured event notification type subject additional provider filter that match provided limit maximum number return single response related applications submitted by business unit id will returned delivery least once meaning time may result one more e duplicate same events have datetime field can used locate ignore duplicates when receiving continue endpoint until they acknowledge been processed your system should send list ids post change those types order validation submission notication scenario application failed mandatory fields missing incorrectly formatted validates input rejects triggering creation accepted awaiting priority outside hours passes initial awaits addition daylist error there attempt create level occurs cannot sent alert integrator protected added processing proccessing completion requisitioned caseworker raises requisition requesting document correspondence despatched completed successfully passed steps including approval cancelled upload attached user uploads required during attaches file sends attachment success fails due issues such incorrect format corrupted details triggers message confirms intended because violates formatting rules implementing example requests responses examples payloads produced view submit v1 2025 01 01t00 00 http 1 copy code data 3fa85f64 5717 4562 b3fc 2c963f66afa6 03 06t14 32 55 295z payload schema https com string additionalprop1 additionalprop2 additionalprop3"
Copy file name to clipboardExpand all lines: app/apis/notifications/1.0/technical-guide.md
+118Lines changed: 118 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,6 +74,124 @@ Duplicate events will have the same `event_datetime` field and `notification_typ
74
74
75
75
Once a notification has been processed by your system, the notification should be acknowledged. To do this, send a list of `notification_ids` to the Acknowledge notifications API as a POST request. This will change the status of those notifications to `ACKNOWLEDGED`.
76
76
77
+
<br>
78
+
79
+
### Notification types {.govuk-heading-s}
80
+
<tableclass="govuk-table">
81
+
<captionclass="govuk-table__caption govuk-table__caption--s">Order validation and submission</caption>
<td class="govuk-table__cell">An application is submitted, but mandatory fields are missing or incorrectly formatted. The system validates the input and rejects the application, triggering this notification
<td class="govuk-table__cell">An application submitted outside business hours passes initial validation, is accepted, and awaits addition to the Daylist
<td class="govuk-table__cell">There is an attempt to create an application, but a system-level error occurs. The application cannot be processed, and this notification is sent to alert the integrator
<td class="govuk-table__cell">A user uploads a required document to an application during processing. The system successfully attaches the file and sends this notification
<td class="govuk-table__cell">A user uploads an attachment, but the file fails validation due to issues such as incorrect format, corrupted file, or missing mandatory details. The system rejects the attachment and triggers this notification
<td class="govuk-table__cell">A message intended for the application fails validation because it violates formatting rules. The system rejects the message and sends this notification
0 commit comments