Skip to content

Commit b29bc86

Browse files
caitlinroach4caitlinroach4
committed
Changes
1 parent acde58e commit b29bc86

File tree

9 files changed

+2144
-0
lines changed

9 files changed

+2144
-0
lines changed

‎_site/apis/application-information copy/0.3/index.html‎

Lines changed: 262 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,262 @@
1+
<!DOCTYPE html>
2+
<html lang="en" class="govuk-template govuk-template--rebranded">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Application Information API - HM Land Registry Developer Pack</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
7+
<meta name="theme-color" content="#789904">
8+
9+
<link rel="icon" href="/hmlrassets/images/favicon.ico" sizes="any"><link rel="mask-icon" href="/hmlrassets/images/mask-icon.svg" color="#789904"><link rel="apple-touch-icon" href="/hmlrassets/images/apple-touch-icon.png">
10+
<script src="/assets/application.js" type="module"></script>
11+
12+
<link rel="stylesheet" href="/assets/application.css">
13+
14+
15+
<meta property="og:title" content="Application Information API">
16+
17+
<script src="/assets/script.js"></script><script>
18+
function setVersion() {
19+
let version = document.getElementById('version').value;
20+
if (!window.location.href.includes(version + '/')) {
21+
console.log(`Versions were different, navigating to ${version}`)
22+
if (window.location.href.match(/\/[0-9.]+\//))
23+
window.location.href = window.location.href.replace(/\/[0-9.]+\//, `/${version}/`)
24+
else
25+
window.location.href = `./${version}`
26+
} else {
27+
console.log(`Version has not changed`);
28+
}
29+
}
30+
document.addEventListener("DOMContentLoaded", () => {
31+
setVersion()
32+
});
33+
</script>
34+
<meta property="og:image" content="/hmlrassets/images/hmlr-opengraph-image.png">
35+
</head>
36+
<body class="govuk-template__body">
37+
<script>document.body.className += ' js-enabled' + ('noModule' in HTMLScriptElement.prototype ? ' govuk-frontend-supported' : '');</script>
38+
39+
<a href="#main-content" class="govuk-skip-link" data-module="govuk-skip-link">Skip to main content</a>
40+
41+
42+
<header class="govuk-header app-header govuk-header--full-width-border" role="banner" data-module="govuk-header">
43+
<div class="govuk-header__container govuk-width-container app-header__container">
44+
<div class="govuk-header__logo app-header__logo">
45+
<a href="/" class="govuk-header__link govuk-header__link--homepage">
46+
<span class="app-header__logotype">HM Land Registry Developer Pack</span>
47+
</a>
48+
</div>
49+
<app-search class="app-search govuk-!-display-none-print" index="/search-index.json" label="Search developer pack"><a class="app-search__link" href="/sitemap">Sitemap</a></app-search>
50+
51+
</div>
52+
</header>
53+
54+
55+
56+
<div class="govuk-service-navigation app-service-navigation"
57+
data-module="govuk-service-navigation"
58+
>
59+
<div class="govuk-width-container">
60+
61+
<div class="govuk-service-navigation__container">
62+
63+
64+
65+
</div>
66+
67+
</div>
68+
69+
</div>
70+
71+
72+
73+
<div class="govuk-width-container">
74+
<a href="javascript:window.history.back()" class="govuk-back-link">Back</a>
75+
<main class="govuk-main-wrapper" id="main-content">
76+
<div class="app-prose-scope"><div class="govuk-grid-row">
77+
<div class="govuk-grid-column-two-thirds">
78+
<h1 class="govuk-heading-xl">
79+
Application information API
80+
</h1>
81+
<p class="govuk-body-l">Use this service to get information about a specific application.</p>
82+
<div class="govuk-warning-text">
83+
<span class="govuk-warning-text__icon" aria-hidden="true">!</span>
84+
<strong class="govuk-warning-text__text">
85+
<span class="govuk-visually-hidden">Warning</span>
86+
These API endpoints are not currently live.
87+
</strong>
88+
</div>
89+
<hr class="govuk-section-break govuk-section-break--visible">
90+
</div>
91+
</div>
92+
<div class="govuk-grid-row">
93+
<div class="govuk-grid-column-two-thirds">
94+
<hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible govuk-!-margin-top-0">
95+
<div class="bg-version-grid">
96+
<div>
97+
<h2 class="govuk-heading-m govuk-!-margin-0" id="version-and-status">Version and status</h2>
98+
</div>
99+
<div class="govuk-form-group version-group govuk-!-margin-0">
100+
<label class="govuk-label govuk-visually-hidden" for="version">
101+
Version and status dropdown
102+
</label>
103+
<select class="govuk-select" id="version" name="version">
104+
<option value="0.3" selected>v0.3 (latest)</option>
105+
</select>
106+
<button type="submit"
107+
class="govuk-button govuk-!-margin-0"
108+
data-module="govuk-button"
109+
onclick="setVersion();"
110+
>View</button>
111+
</div>
112+
</div>
113+
<hr class="govuk-section-break govuk-section-break--m govuk-section-break--visible">
114+
<div>
115+
<h2 class="govuk-heading-m" id="overview"><br>Overview</h2>
116+
<p class="govuk-body">The Application information API is used to get detailed information about a specific
117+
application. This includes:</p>
118+
<ul class="govuk-list govuk-list--bullet">
119+
<li>the status of an application</li>
120+
<li>the <code class="x-govuk-code x-govuk-code--inline">application_request_id</code> used in the
121+
request</li>
122+
<li>an ID for the accepted application, <code
123+
class="x-govuk-code x-govuk-code--inline">hmlr_reference</code>, once accepted (previously known as
124+
ABR)</li>
125+
<li>the priority of the application, <code
126+
class="x-govuk-code x-govuk-code--inline">priority_timestamp</code>, once accepted</li>
127+
<li>any errors that prevented application submission</li>
128+
<li>any warnings that did not prevent submission but need to be addressed before a caseworker can process the
129+
application (otherwise a requisition may occur)</li>
130+
</ul>
131+
<p class="govuk-body">This API can be used to get more information after receiving a notification indicating the
132+
application has changed. For information about which notifications will be available, visit the notifications
133+
section of the <a class="govuk-body govuk-link" href="/apis/submit-an-application">Submit an application</a> API
134+
page.</p>
135+
</div>
136+
<div>
137+
<h2 class="govuk-heading-m" id="view-the-technical-guide">View the Technical guide</h2>
138+
<ul class="govuk-list">
139+
<li>
140+
<a class="govuk-body govuk-link" href="./technical-guide">Technical guide</a>
141+
</li>
142+
</ul>
143+
</div>
144+
<div>
145+
<h2 class="govuk-heading-m" id="view-the-api-specification">View the API specification</h2>
146+
<ul class="govuk-list">
147+
<li>
148+
<a class="govuk-body govuk-link"
149+
href="https://landregistry.github.io/bgtechdoc/vcad/v0_3/vcad-spec.html#tag/Application-information-API"
150+
rel="noreferrer noopener" target="_blank">Web version (opens in new tab)</a>
151+
</li>
152+
</ul>
153+
</div>
154+
<br>
155+
<div>
156+
<h3 class="govuk-heading-m" id="how-the-service-api-works">How the API works</h3>
157+
<div class="govuk-!-padding-bottom-3"></div>
158+
<h4 class="govuk-heading-m">Interaction</h4>
159+
<div class="govuk-!-padding-bottom-5">
160+
<a target="_blank" href="/assets/images/ApplicationInformation_interaction_diagram.png"><img src="/assets/images/ApplicationInformation_interaction_diagram.png"
161+
alt="A diagram showing the interaction of the Application Information API."></a></div>
162+
<p class="govuk-body">This diagram demonstrates how the Application information API works to support users. </p>
163+
<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>
164+
<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>
165+
<h4 class="govuk-heading-m">State diagram</h4>
166+
<div class="govuk-!-margin-bottom-5">
167+
<a target="_blank" href="/assets/images/ApplicationInformation_State_diagram.png"><img src="/assets/images/ApplicationInformation_State_diagram.png"
168+
alt="A diagram showing how the Application Information API works."></a></div>
169+
</div>
170+
<div class="govuk-!-padding-bottom-3"></div>
171+
<p class="govuk-body">The state diagram demonstrates how the validation process works once an application has been submitted.</p>
172+
<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>
173+
<ul class="govuk-list--bullet">
174+
<li class="govuk-body">informing the user that an application has passed validation and has been added to the day list</li>
175+
<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>
176+
<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>
177+
</ul>
178+
<div class="govuk-!-padding-bottom-3"></div>
179+
<div>
180+
<h3 class="govuk-heading-m" id="how-to-test-this-service-api">How to test this API</h3>
181+
<p class="govuk-body">HMLR has created a test environment for the Application information API. We’ve also provided example code to demonstrate what you should expect when developing your own services.</p>
182+
<ul class="govuk-list">
183+
<li>
184+
<p class="govuk-body"><a class="govuk-body govuk-link" href="./test-stubs">View
185+
Application information test stubs</a>.</p>
186+
</li>
187+
</ul>
188+
<div class="govuk-inset-text">Please note there are also plans to release a sandbox test environment for developers in the future. The exact release date is to be confirmed.</div>
189+
<p class="govuk-body">For general testing guidance, visit our <a class="govuk-body govuk-link"
190+
href="/a-guide-to-testing">guide to testing</a>.</p>
191+
</div>
192+
</div>
193+
<div class="govuk-grid-column-one-third">
194+
<aside class="related-items" role="complementary">
195+
<h2 class="govuk-heading-m" id="related-apis">
196+
Related APIs
197+
</h2>
198+
<nav role="navigation" aria-labelledby="related-apis">
199+
<ul class="govuk-list govuk-!-font-size-16">
200+
<li>
201+
<a class="govuk-body govuk-link" href="/apis/submit-an-application-to-change-the-land-register">
202+
Submit an application to change the Land Register
203+
</a>
204+
</li>
205+
<li>
206+
<a class="govuk-body govuk-link" href="/apis/send-a-document">
207+
Send a document
208+
</a>
209+
</li>
210+
<li>
211+
<a class="govuk-body govuk-link" href="/apis/submit-an-application">
212+
Submit an application
213+
</a>
214+
</li>
215+
<li>
216+
</li>
217+
<li>
218+
<a class="govuk-body govuk-link" href="/apis/notifications">
219+
Notifications
220+
</a>
221+
</li>
222+
<li>
223+
<a class="govuk-body govuk-link govuk-!-font-weight-bold" href="/find-a-service-api">
224+
More <span class="govuk-visually-hidden">in Subsection</span>
225+
</a>
226+
</li>
227+
</ul>
228+
</nav>
229+
</aside>
230+
</div>
231+
</div></div>
232+
233+
</main>
234+
</div>
235+
236+
<footer class="govuk-footer govuk-footer--hmlr " role="contentinfo">
237+
<div class="govuk-width-container ">
238+
<div class="govuk-footer__meta">
239+
<div class="govuk-footer__meta-item govuk-footer__meta-item--grow">
240+
<h2 class="govuk-visually-hidden">These links open in a new tab.</h2>
241+
<ul class="govuk-footer__inline-list">
242+
<li class="govuk-footer__inline-list-item">
243+
<a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html">
244+
Accessibility Statement
245+
</a>
246+
</li>
247+
</ul>
248+
<div class="govuk-footer__meta-custom">
249+
These links open in a new tab.
250+
</div>
251+
</div>
252+
<div class="govuk-footer__meta-item">
253+
<span
254+
class="govuk-footer__link govuk-footer__copyright-logo govuk-footer__copyright-logo--hmlr"
255+
>&copy; Crown copyright</span>
256+
</div>
257+
</div>
258+
</div>
259+
</footer>
260+
261+
</body>
262+
</html>

0 commit comments

Comments
 (0)