Skip to content

Commit 53f2e63

Browse files
IuhegiIuhegi
authored
Merge pull request #10 from LandRegistry/feat/vcadv1golive
Add v1 submit an application and versioning policy
2 parents 47ecf98 + 16386df commit 53f2e63

File tree

46 files changed

+665
-395
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+665
-395
lines changed

‎_site/apis/application-information/1.0/index.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en" class="govuk-template govuk-template--rebranded">
33
<head>
44
<meta charset="utf-8">
5-
<title>Application Information API - HM Land Registry Developer Pack</title>
5+
<title>Application information API - HM Land Registry Developer Pack</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
77
<meta name="theme-color" content="#789904">
88

@@ -12,8 +12,8 @@
1212
<link rel="stylesheet" href="/assets/application.css">
1313

1414

15-
<meta property="og:title" content="Application Information API">
16-
<meta property="og:description" name="description" content="Use this service to get information about a specific application.">
15+
<meta property="og:title" content="Application information API">
16+
<meta property="og:description" name="description" content="Use this service to get information about a specific application">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Application Information API</h1><p class="govuk-body-l">Use this service to get information about a specific&nbsp;application.</p>
81+
<h1 class="govuk-heading-xl">Application information API</h1><p class="govuk-body-l">Use this service to get information about a specific&nbsp;application</p>
8282
</header>
8383

8484
</div>
@@ -115,13 +115,13 @@ <h2 class="govuk-heading-m govuk-!-margin-0" id="version-and-status">Version and
115115
<li>the <code class="app-code app-code--inline">application_request_id</code> used in the request</li>
116116
<li>an ID for the accepted application, <code class="app-code app-code--inline">hmlr_reference</code>, once accepted (previously known as ABR)</li>
117117
<li>the priority of the application, <code class="app-code app-code--inline">priority_timestamp</code>, once accepted</li>
118-
<li>any errors that prevented application submission</li>
118+
<li>any errors that prevented application submission, including <code class="app-code app-code--inline">VALIDATION_FAILED</code></li>
119119
<li>any warnings that did not prevent submission but need to be addressed before a caseworker can process the application (otherwise a requisition may occur)</li>
120120
<li>a list of correspondence records associated with the application including:
121121
<ul class="govuk-list govuk-list--bullet">
122-
<li>Completion documents</li>
123-
<li>Cancellation documents</li>
124-
<li>Requsition documents</li>
122+
<li>completion documents</li>
123+
<li>cancellation documents</li>
124+
<li>requisition documents</li>
125125
</ul>
126126
</li>
127127
</ul>

‎_site/apis/application-information/1.0/technical-guide/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ <h2 class="govuk-heading-m" id="how-to-use-the-application-information-api" tabi
180180
<p class="govuk-body">The Application information API is used to get detailed information about a specific application, using the <code class="app-code app-code--inline">application_request_id</code> returned by the Submit an application API request.</p>
181181
<p class="govuk-body">The status of an application can currently be one of the following:</p>
182182
<ul class="govuk-list govuk-list--bullet">
183-
<li><code class="app-code app-code--inline">VALIDATING</code> - HM Land Registry is still processing the application, and it has not yet been added to the day list</li>
183+
<li><code class="app-code app-code--inline">VALIDATING</code> - HMLR is still processing the application, and it has not yet been added to the day list</li>
184184
<li><code class="app-code app-code--inline">VALIDATION_FAILED</code> - The application has not been added to the day list due to errors during validation. The errors found are included in the errors section of the response</li>
185185
<li><code class="app-code app-code--inline">ACCEPTED_AWAITING_PRIORITY</code> - The application has passed validation but has not yet been added to the day list as it is currently closed. The application will be added to the day list and moved to an <code class="app-code app-code--inline">ACCEPTED_PRIORITY_PROTECTED</code> state when the day list reopens</li>
186186
<li><code class="app-code app-code--inline">ACCEPTED_PRIORITY_PROTECTED</code> - The application has been accepted onto the day list, and has priority</li>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en" class="govuk-template govuk-template--rebranded">
33
<head>
44
<meta charset="utf-8">
5-
<title>Application Information API - HM Land Registry Developer Pack</title>
5+
<title>Application information API - HM Land Registry Developer Pack</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
77
<meta name="theme-color" content="#789904">
88

@@ -12,8 +12,8 @@
1212
<link rel="stylesheet" href="/assets/application.css">
1313

1414

15-
<meta property="og:title" content="Application Information API">
16-
<meta property="og:description" name="description" content="Use this service to get information about a specific application.">
15+
<meta property="og:title" content="Application information API">
16+
<meta property="og:description" name="description" content="Use this service to get information about a specific application">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Application Information API</h1><p class="govuk-body-l">Use this service to get information about a specific&nbsp;application.</p>
81+
<h1 class="govuk-heading-xl">Application information API</h1><p class="govuk-body-l">Use this service to get information about a specific&nbsp;application</p>
8282
</header>
8383

8484
</div>

‎_site/apis/attach-a-document/1.0/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
<meta property="og:title" content="Attach a document API">
16-
<meta property="og:description" name="description" content="Use this service to attach a document to a submitted order.">
16+
<meta property="og:description" name="description" content="Use this service to attach a document to a submitted application">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Attach a document API</h1><p class="govuk-body-l">Use this service to attach a document to a submitted&nbsp;order.</p>
81+
<h1 class="govuk-heading-xl">Attach a document API</h1><p class="govuk-body-l">Use this service to attach a document to a submitted&nbsp;application</p>
8282
</header>
8383

8484
</div>

‎_site/apis/attach-a-document/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
<meta property="og:title" content="Attach a document API">
16-
<meta property="og:description" name="description" content="Use this service to attach a document to a submitted order.">
16+
<meta property="og:description" name="description" content="Use this service to attach a document to a submitted order">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Attach a document API</h1><p class="govuk-body-l">Use this service to attach a document to a submitted&nbsp;order.</p>
81+
<h1 class="govuk-heading-xl">Attach a document API</h1><p class="govuk-body-l">Use this service to attach a document to a submitted&nbsp;order</p>
8282
</header>
8383

8484
</div>

‎_site/apis/attach-a-message/1.0/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
<meta property="og:title" content="Attach a message API">
16-
<meta property="og:description" name="description" content="Use this service to attach text messages to an existing application.">
16+
<meta property="og:description" name="description" content="Use this service to attach text messages to an existing application">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Attach a message API</h1><p class="govuk-body-l">Use this service to attach text messages to an existing&nbsp;application.</p>
81+
<h1 class="govuk-heading-xl">Attach a message API</h1><p class="govuk-body-l">Use this service to attach text messages to an existing&nbsp;application</p>
8282
</header>
8383

8484
</div>

‎_site/apis/attach-a-message/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en" class="govuk-template govuk-template--rebranded">
33
<head>
44
<meta charset="utf-8">
5-
<title>Attach a document - HM Land Registry Developer Pack</title>
5+
<title>Attach a document API - HM Land Registry Developer Pack</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
77
<meta name="theme-color" content="#789904">
88

@@ -12,8 +12,8 @@
1212
<link rel="stylesheet" href="/assets/application.css">
1313

1414

15-
<meta property="og:title" content="Attach a document">
16-
<meta property="og:description" name="description" content="Use this service to attach a document to a submitted order.">
15+
<meta property="og:title" content="Attach a document API">
16+
<meta property="og:description" name="description" content="Use this service to attach a document to a submitted order">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Attach a document</h1><p class="govuk-body-l">Use this service to attach a document to a submitted&nbsp;order.</p>
81+
<h1 class="govuk-heading-xl">Attach a document API</h1><p class="govuk-body-l">Use this service to attach a document to a submitted&nbsp;order</p>
8282
</header>
8383

8484
</div>

‎_site/apis/download-a-document/1.0/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
<meta property="og:title" content="Download a document API">
16-
<meta property="og:description" name="description" content="Use this service to download documents created by HM Land Registry.">
16+
<meta property="og:description" name="description" content="Use this service to download documents created by HMLR">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Download a document API</h1><p class="govuk-body-l">Use this service to download documents created by HM Land&nbsp;Registry.</p>
81+
<h1 class="govuk-heading-xl">Download a document API</h1><p class="govuk-body-l">Use this service to download documents created by&nbsp;HMLR</p>
8282
</header>
8383

8484
</div>
@@ -126,7 +126,7 @@ <h2 class="govuk-heading-m" id="view-the-technical-guide" tabindex="-1" class="g
126126
<p class="govuk-body"><a href="/apis/download-a-document/1.0/technical-guide" class="govuk-link">Technical guide</a></p>
127127
</section>
128128
<section>
129-
## View the API specification {.govuk-heading-m}
129+
<h2 class="govuk-heading-m" id="view-the-api-specification" tabindex="-1" class="govuk-heading-l">View the API specification</h2>
130130
<p class="govuk-body"><a href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/documents/submit-an-application-to-change-the-register/v1.0/openapi.html#tag/Download-a-document-API" rel="noreferrer noopener" target="_blank" class="govuk-link">Web version (opens in a new tab)</a></p>
131131
</section>
132132
<section>

‎_site/apis/download-a-document/1.0/technical-guide/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
<meta property="og:title" content="Download a document API technical guide">
16-
<meta property="og:description" name="description" content="Use this service to download documents provided by HM Land Registry.">
16+
<meta property="og:description" name="description" content="Use this service to download documents provided by HMLR">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -148,7 +148,7 @@ <h3 class="x-govuk-sub-navigation__theme">Contents</h3>
148148

149149

150150
<header class="app-document-header">
151-
<h1 class="govuk-heading-xl">Download a document API technical guide</h1><p class="govuk-body-l">Use this service to download documents provided by HM Land&nbsp;Registry.</p>
151+
<h1 class="govuk-heading-xl">Download a document API technical guide</h1><p class="govuk-body-l">Use this service to download documents provided by&nbsp;HMLR</p>
152152
</header>
153153

154154

‎_site/apis/download-a-document/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en" class="govuk-template govuk-template--rebranded">
33
<head>
44
<meta charset="utf-8">
5-
<title>Download a document - HM Land Registry Developer Pack</title>
5+
<title>Download a document API - HM Land Registry Developer Pack</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
77
<meta name="theme-color" content="#789904">
88

@@ -12,8 +12,8 @@
1212
<link rel="stylesheet" href="/assets/application.css">
1313

1414

15-
<meta property="og:title" content="Download a document">
16-
<meta property="og:description" name="description" content="Use this service to download documents.">
15+
<meta property="og:title" content="Download a document API">
16+
<meta property="og:description" name="description" content="Use this service to download documents created by HMLR">
1717
<script src="/assets/script.js"></script><script>
1818
function setVersion() {
1919
let version = document.getElementById('version').value;
@@ -78,7 +78,7 @@
7878
<div class="govuk-grid-column-full">
7979

8080
<header class="app-document-header">
81-
<h1 class="govuk-heading-xl">Download a document</h1><p class="govuk-body-l">Use this service to download&nbsp;documents.</p>
81+
<h1 class="govuk-heading-xl">Download a document API</h1><p class="govuk-body-l">Use this service to download documents created by&nbsp;HMLR</p>
8282
</header>
8383

8484
</div>

0 commit comments

Comments
 (0)