Skip to content

Commit 80b5dbc

Browse files
author
Emeli, Frank
committed
Merge branch 'revert-notifications-table' into 'main'
(revert) Revert "docs: add notification type table" See merge request business-gateway/documentation/developer-pack!13
2 parents cf2994c + 0ea19b6 commit 80b5dbc

File tree

3 files changed

+143
-376
lines changed

3 files changed

+143
-376
lines changed

_site/apis/notifications/1.0/technical-guide/index.html

Lines changed: 0 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -195,121 +195,6 @@ <h3 class="govuk-heading-s" id="recieve-notifications" tabindex="-1" class="govu
195195
<p class="govuk-body">Duplicate events will have the same <code class="app-code app-code--inline">event_datetime</code> field and <code class="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>
196196
<h3 class="govuk-heading-s" id="acknowledge-notifications" tabindex="-1" class="govuk-heading-m">Acknowledge notifications</h3>
197197
<p class="govuk-body">Once a notification has been processed by your system, the notification should be acknowledged. To do this, send a list of <code class="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 <code class="app-code app-code--inline">ACKNOWLEDGED</code>.</p>
198-
<br>
199-
<h3 class="govuk-heading-s" id="notification-types" tabindex="-1" class="govuk-heading-m">Notification types</h3>
200-
<table class="govuk-table">
201-
<caption class="govuk-table__caption govuk-table__caption--s">Order validation and submission</caption>
202-
<thead class="govuk-table__head">
203-
<tr class="govuk-table__row">
204-
<th scope="col" class="govuk-table__header">Notification type</th>
205-
<th scope="col" class="govuk-table__header">Scenario</th>
206-
<th scope="col" class="govuk-table__header">Response</th>
207-
</tr>
208-
</thead>
209-
<tbody class="govuk-table__body">
210-
<tr class="govuk-table__row">
211-
<td class="govuk-table__cell" style="width:20%">Application failed validation</td>
212-
<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
213-
</td>
214-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.creation.application.failed-validation</code>
215-
</td>
216-
</tr>
217-
<tr class="govuk-table__row">
218-
<td class="govuk-table__cell">Application accepted awaiting priority</td>
219-
<td class="govuk-table__cell">An application submitted outside business hours passes initial validation, is accepted, and awaits addition to the Daylist
220-
</td>
221-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.creation.application.accepted-awaiting-priority</code>
222-
</td>
223-
</tr>
224-
<tr class="govuk-table__row">
225-
<td class="govuk-table__cell">System error</td>
226-
<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
227-
</td>
228-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.creation.application.error</code>
229-
</td>
230-
</tr>
231-
<tr class="govuk-table__row">
232-
<td class="govuk-table__cell">Application accepted priority protected</td>
233-
<td class="govuk-table__cell">An application submitted passes initial validation, is accepted, and added to the Daylist
234-
</td>
235-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.application.accepted-priority-protected</code>
236-
</td>
237-
</tr>
238-
</tbody>
239-
</table>
240-
<table class="govuk-table">
241-
<caption class="govuk-table__caption govuk-table__caption--s">Order essing and completion</caption>
242-
<thead class="govuk-table__head">
243-
<tr class="govuk-table__row">
244-
<th scope="col" class="govuk-table__header">Notification type</th>
245-
<th scope="col" class="govuk-table__header">Scenario</th>
246-
<th scope="col" class="govuk-table__header">Response</th>
247-
</tr>
248-
</thead>
249-
<tbody class="govuk-table__body">
250-
<tr class="govuk-table__row">
251-
<td class="govuk-table__cell">Application requisitioned</td>
252-
<td class="govuk-table__cell">A caseworker raises a requisition on an application requesting a response or document</td>
253-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.correspondence-despatched</code>
254-
</td>
255-
</tr>
256-
<tr class="govuk-table__row">
257-
<td class="govuk-table__cell">Application completed</td>
258-
<td class="govuk-table__cell">The application has successfully passed all processing steps, including validation and approval
259-
</td>
260-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.application.completed</code>
261-
</td>
262-
</tr>
263-
<tr class="govuk-table__row">
264-
<td class="govuk-table__cell">Application cancelled</td>
265-
<td class="govuk-table__cell">The application was in processing but was cancelled
266-
</td>
267-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.application.cancelled</code>
268-
</td>
269-
</tr>
270-
</tbody>
271-
</table>
272-
<table class="govuk-table">
273-
<caption class="govuk-table__caption govuk-table__caption--s">Response and document upload for applications</caption>
274-
<thead class="govuk-table__head">
275-
<tr class="govuk-table__row">
276-
<th scope="col" class="govuk-table__header">Notification type</th>
277-
<th scope="col" class="govuk-table__header">Scenario</th>
278-
<th scope="col" class="govuk-table__header">Response</th>
279-
</tr>
280-
</thead>
281-
<tbody class="govuk-table__body">
282-
<tr class="govuk-table__row">
283-
<td class="govuk-table__cell">Document successfully attached</td>
284-
<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
285-
</td>
286-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.attachment-success</code>
287-
</td>
288-
</tr>
289-
<tr class="govuk-table__row">
290-
<td class="govuk-table__cell">Document attached failed validation</td>
291-
<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
292-
</td>
293-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.attachment-failed</code>
294-
</td>
295-
</tr>
296-
<tr class="govuk-table__row">
297-
<td class="govuk-table__cell">Message successfully attached</td>
298-
<td class="govuk-table__cell">A message is successfully added to the application during processing and the system confirms the attachment
299-
</td>
300-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.message-success</code>
301-
</td>
302-
</tr>
303-
<tr class="govuk-table__row">
304-
<td class="govuk-table__cell">Message failed validation</td>
305-
<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
306-
</td>
307-
<td class="govuk-table__cell govuk-!-width-one-third" style="white-space:pre-wrap; word-break:break-all"><code class="app-code app-code--inline">applications.processing.message-failed</code>
308-
</td>
309-
</tr>
310-
</tbody>
311-
</table>
312-
<br>
313198
</section>
314199
<section>
315200
<h2 class="govuk-heading-m" id="validation-rules" tabindex="-1" class="govuk-heading-l">Validation rules</h2>

0 commit comments

Comments
 (0)