Skip to content

Find a service API links and content tweaks #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Find a service API links and content tweaks #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
703122f
Find a service API links and content tweaks
Jun 25, 2025
b836345
Adding the step by step navigation on the submit an application to th…
Jun 27, 2025
d54f25a
Updating submit an app to change text alt
caitlinroach4 Jul 29, 2025
a39a7e7
Send a document text alt
caitlinroach4 Jul 29, 2025
1202d0f
Submit app API text alt
caitlinroach4 Jul 29, 2025
7de0de9
Notifications API text alt
caitlinroach4 Jul 29, 2025
63caed9
Application info API text lt
caitlinroach4 Jul 29, 2025
b3b1b47
Update to app info text alternate
caitlinroach4 Jul 29, 2025
3df7577
Removed What's new from homepage
caitlinroach4 Jul 29, 2025
ff75408
Remove notifications from Find an API page
caitlinroach4 Jul 29, 2025
4788e07
Add glossary link to hompage
caitlinroach4 Jul 30, 2025
eec7d69
removal of text referring to what's new section
caitlinroach4 Jul 30, 2025
398e870
Update application-information.html
caitlinroach4 Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 19 additions & 41 deletions app/views/apis/application-information-technical-guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,51 +187,29 @@ <h3 class="govuk-heading-s"><code>GET /v0/applications/{id}/status</code> - ACCE
</code>
</pre>

<div class="govuk-!-padding-bottom-3"></div>

<hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible">
<h3 class="govuk-heading-m">Related APIs</h3>
<ul class="govuk-list">
<li>
<a class="govuk-link" href="/apis/send-a-document">Send a document API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application">Submit an application API</a>
</li>
<li>
<a class="govuk-link" href="/apis/notifications">Notifications API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application-to-change-the-land-register">Submit an application to change the land register API</a>
</li>
</ul>

</div>
</div>
</div>

<div class="govuk-grid-column-one-third">

<aside class="govuk-prototype-kit-common-templates-related-items" role="complementary">
<h2 class="govuk-heading-m" id="related-apis">
Related APIs
</h2>
<nav role="navigation" aria-labelledby="subsection-title">
<ul class="govuk-list govuk-!-font-size-16">
<li>
<a class="govuk-body govuk-link" href="/apis/submit-an-application-to-change-the-land-register">
Submit an application to change the Land Register
</a>
</li>
<li>
<a class="govuk-body govuk-link" href="/apis/send-a-document">
Send a document
</a>
</li>
<li>
<a class="govuk-body govuk-link" href="/apis/submit-an-application">
Submit an application
</a>
</li>
<li>
</li>
<li>
<a class="govuk-body govuk-link" href="/apis/notifications">
Notifications
</a>
</li>
<li>
<a class="govuk-body govuk-link govuk-!-font-weight-bold" href="/find-a-service-api">
More <span class="govuk-visually-hidden">in Subsection</span>
</a>
</li>
</ul>
</nav>
</aside>
</main>

</div>
</div>

{% endblock %}
17 changes: 17 additions & 0 deletions app/views/apis/application-information-test-stubs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,23 @@ <h3 class="govuk-heading-s">Response</h3>

<div class="govuk-!-padding-bottom-3"></div>

<hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible">
<h3 class="govuk-heading-m">Related APIs</h3>
<ul class="govuk-list">
<li>
<a class="govuk-link" href="/apis/send-a-document">Send a document API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application">Submit an application API</a>
</li>
<li>
<a class="govuk-link" href="/apis/notifications">Notifications API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application-to-change-the-land-register">Submit an application to change the land register API</a>
</li>
</ul>

</main>

</div>
Expand Down
80 changes: 33 additions & 47 deletions app/views/apis/application-information.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,42 +47,7 @@ <h1 class="govuk-heading-xl">
These API endpoints are not currently live.
</strong>
</div>

<aside class="govuk-prototype-kit-common-templates-mainstream-guide-contents-list" role="complementary">
<nav class="govuk-prototype-kit-common-templates-contents-list" aria-label="Pages in this guide" role="navigation">
<h2 class="govuk-prototype-kit-common-templates-contents-list__title">
Contents
</h2>
<ol class="govuk-prototype-kit-common-templates-contents-list__list">
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed govuk-prototype-kit-common-templates-contents-list__list-item--active">
<a href="#overview">
Overview
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#view-the-technical-guide">
View the technical guide
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#view-the-api-specification">
View the API specification
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#how-the-service-api-works">
How the API works
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#how-to-test-this-service-api">
How to test this API
</a>
</li>
</ol>
</nav>
</aside>

<hr class="govuk-section-break govuk-section-break--visible">
</div>

</div>
Expand All @@ -107,6 +72,38 @@ <h2 class="govuk-heading-m" id="overview"><br>Overview</h2>

</div>

<div>
<h3 class="govuk-heading-m" id="how-the-service-api-works">How the API works</h3>
<div class="govuk-!-padding-bottom-3"></div>
<h4 class="govuk-heading-m">Interaction</h4>
<div class="govuk-!-padding-bottom-3"></div>

<img src="/public/images/ApplicationInformation_interaction_diagram.png" alt="A diagram showing the interaction of the Application Information API.">
<br><br>
<p class="govuk-body">This diagram demonstrates how the Application information API works to support users. </p>
<p class="govuk-body">Using their unique application ID (provided via the Submit an application API), a user can request information about a specific application. Examples of the type of information are listed in the overview section. </p>
<p class="govuk-body">The HMLR system will respond with the relevant information. The system may also respond by informing users that their application has been accepted onto the day list or if it has failed validation.</p>

<br>
<h4 class="govuk-heading-m">State diagram</h4>
<div class="govuk-!-padding-bottom-3"></div>
<img src="/public/images/ApplicationInformation_State_diagram.png" alt="A diagram showing how the Application Information API works.">
<br><br>

<p class="govuk-body">The state diagram demonstrates how the validation process works once an application has been submitted.</p>
<p class="govuk-body">When the system starts the validation process, there are several potential outcomes which can each trigger a different response. A response may include:</p>
<ul class="govuk-list--bullet">
<li class="govuk-body">informing the user that an application has passed validation and has been added to the day list</li>
<li class="govuk-body">informing the user that an application has passed validation but is awaiting priority as the day list is closed. Once the day list reopens, the application will be added</li>
<li class="govuk-body">informing the user that an application has not passed validation. In this case, the system will indicate whether a validation or system error has occurred. The user must correct the error and resubmit the application</li>
</ul>
<br><br>

</div>
<div class="govuk-!-padding-bottom-3"></div>



<div>
<h2 class="govuk-heading-m" id="view-the-technical-guide">View the technical guide</h2>

Expand All @@ -126,17 +123,6 @@ <h2 class="govuk-heading-m" id="view-the-api-specification">View the API specifi
</li>
</ul>
</div>

<div>
<h3 class="govuk-heading-m" id="how-the-service-api-works">How the API works</h3>
<div class="govuk-!-padding-bottom-3"></div>
<h4 class="govuk-heading-m">Interaction</h4>
<div class="govuk-!-padding-bottom-3"></div>
<img src="/public/images/ApplicationInformation_interaction_diagram.png" alt="A diagram showing the interaction of the Application Information API.">
<h4 class="govuk-heading-m">State diagram</h4>
<div class="govuk-!-padding-bottom-3"></div>
<img src="/public/images/ApplicationInformation_State_diagram.png" alt="A diagram showing how the Application Information API works.">
</div>
<br>

<div>
Expand Down
57 changes: 17 additions & 40 deletions app/views/apis/notifications-technical-guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,49 +226,26 @@ <h3 class="govuk-heading-s">Acknowledge notifications response</h3>
</pre>

<div class="govuk-!-padding-bottom-6"></div>

<hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible">
<h3 class="govuk-heading-m">Related APIs</h3>
<ul class="govuk-list">
<li>
<a class="govuk-link" href="/apis/send-a-document">Send a document API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application">Submit an application API</a>
</li>
<li>
<a class="govuk-link" href="/apis/application-information">Application information API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application-to-change-the-land-register">Submit an application to change the land register API</a>
</li>
</ul>
</div>
</div>
</div>
<div class="govuk-grid-column-one-third">

<aside class="govuk-prototype-kit-common-templates-related-items" role="complementary">
<h2 class="govuk-heading-m" id="related-apis">
Related APIs
</h2>
<nav role="navigation" aria-labelledby="subsection-title">
<ul class="govuk-list govuk-!-font-size-16">
<li>
<a class="govuk-body govuk-link" href="/apis/submit-an-application-to-change-the-land-register">
Submit an application to change the Land Register
</a>
</li>
<li>
<a class="govuk-body govuk-link" href="/apis/application-information">
Application information
</a>
</li>
<li>
<a class="govuk-body govuk-link" href="/apis/send-a-document">
Send a document
</a>
<li>
<a class="govuk-body govuk-link" href="/apis/submit-an-application">
Submit an application
</a>
</li>
<li>
</li>
<li>
<a class="govuk-body govuk-link govuk-!-font-weight-bold" href="/find-a-service-api">
More <span class="govuk-visually-hidden">in Subsection</span>
</a>
</li>
</ul>
</nav>
</aside>

</div>

</div>

</div>
Expand Down
17 changes: 17 additions & 0 deletions app/views/apis/notifications-test-stubs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,23 @@ <h3 class="govuk-heading-s">Response</h3>

<div class="govuk-!-padding-bottom-3"></div>

<hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible">
<h3 class="govuk-heading-m">Related APIs</h3>
<ul class="govuk-list">
<li>
<a class="govuk-link" href="/apis/send-a-document">Send a document API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application">Submit an application API</a>
</li>
<li>
<a class="govuk-link" href="/apis/application-information">Application information API</a>
</li>
<li>
<a class="govuk-link" href="/apis/submit-an-application-to-change-the-land-register">Submit an application to change the land register API</a>
</li>
</ul>

</main>

</div>
Expand Down
55 changes: 15 additions & 40 deletions app/views/apis/notifications.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,46 +47,13 @@ <h1 class="govuk-heading-xl">
These API endpoints are not currently live.
</strong>
</div>

<aside class="govuk-prototype-kit-common-templates-mainstream-guide-contents-list" role="complementary">
<nav class="govuk-prototype-kit-common-templates-contents-list" aria-label="Pages in this guide" role="navigation">
<h2 class="govuk-prototype-kit-common-templates-contents-list__title">
Contents
</h2>
<ol class="govuk-prototype-kit-common-templates-contents-list__list">
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed govuk-prototype-kit-common-templates-contents-list__list-item--active">
<a href="#overview">
Overview
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#view-the-technical-guide">
View the technical guide
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#view-the-api-specification">
View the API specification
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#how-the-service-api-works">
How the API works
</a>
</li>
<li class="govuk-prototype-kit-common-templates-contents-list__list-item govuk-prototype-kit-common-templates-contents-list__list-item--dashed">
<a href="#how-to-test-this-service-api">
How to test this API
</a>
</li>
</ol>
</nav>
</aside>
<hr class="govuk-section-break govuk-section-break--visible">

</div>

</div>


<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds govuk-prototype-kit-common-templates-mainstream-guide-body">

Expand All @@ -104,6 +71,19 @@ <h2 class="govuk-heading-m" id="overview"><br>Overview</h2>

</div>

<div>
<h3 class="govuk-heading-m" id="how-the-service-api-works">How the API works</h3>
<div class="govuk-!-padding-bottom-3"></div>
<img src="/public/images/NotificationInteraction.png" alt="A diagram showing the interaction of the Notification API.">

<br><br>
<h3 class="govuk-heading-s">Notifications API</h3>
<p class="govuk-body">This diagram demonstrates how the Notifications API works to support users. </p>
<p class="govuk-body">A user may send requests to receive notifications about multiple applications at the same time using the Get notifications API. The HMLR system will respond by providing information relevant to the request.</p>
<p class="govuk-body">A user can also notify HMLR that it has received notifications using the Acknowledge notifications API. The system will acknolwedge this notification. </p>

</div>

<div>
<h2 class="govuk-heading-m" id="view-the-technical-guide">View the technical guide</h2>

Expand All @@ -124,11 +104,6 @@ <h2 class="govuk-heading-m" id="view-the-api-specification">View the API specifi
</ul>
</div>

<div>
<h3 class="govuk-heading-m" id="how-the-service-api-works">How the API works</h3>
<div class="govuk-!-padding-bottom-3"></div>
<img src="/public/images/NotificationInteraction.png" alt="A diagram showing the interaction of the Notification API.">
</div>
<br>

<div>
Expand Down
Loading