|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en" class="govuk-template govuk-template--rebranded"> |
| 3 | + <head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <title>Download a document 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="Download a document 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 | + Download a document API |
| 80 | + </h1> |
| 81 | + <p class="govuk-body-l">Use this service to download documents that have been created by HM Land Registry for your consumption.</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.1" selected>v0.1 (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 Download a document API provides a way to download documents that have been created by HM Land Registry for your consumption.</p> |
| 117 | + <p class="govuk-body">This API has one endpoint:</p> |
| 118 | + <ul class="govuk-list govuk-list--bullet"> |
| 119 | + <li><code class="x-govuk-code x-govuk-code--inline">GET /v0/documents/{download_id}</code> - get the binary content of the document.</li> |
| 120 | + </ul> |
| 121 | + <p class="govuk-body">You may obtain a <code class="x-govuk-code x-govuk-code--inline">`download_id`</code> from any of the following:</p> |
| 122 | + <ul class="govuk-list govuk-list--bullet"> |
| 123 | + <li>Completion notifications</li> |
| 124 | + <li>Cancellation notifications</li> |
| 125 | + <li>Requisition correspondence notifications</li> |
| 126 | + <li>The `/correspondence` array in an [application information](/apis/application-information) response</li> |
| 127 | + </ul> |
| 128 | + </div> |
| 129 | + <div> |
| 130 | + <h2 class="govuk-heading-m" id="view-the-technical-guide">View the Technical guide</h2> |
| 131 | + <ul class="govuk-list"> |
| 132 | + <li> |
| 133 | + <a class="govuk-body govuk-link" href="./technical-guide">Technical guide</a> |
| 134 | + </li> |
| 135 | + </ul> |
| 136 | + </div> |
| 137 | + <div> |
| 138 | + <h2 class="govuk-heading-m" id="view-the-api-specification">View the API specification</h2> |
| 139 | + <ul class="govuk-list"> |
| 140 | + <li> |
| 141 | + <a class="govuk-body govuk-link" |
| 142 | + href="https://landregistry.github.io/bgtechdoc/vcad/v0_3/vcad-spec.html#tag/Application-information-API" |
| 143 | + rel="noreferrer noopener" target="_blank">Web version (opens in new tab)</a> |
| 144 | + </li> |
| 145 | + </ul> |
| 146 | + </div> |
| 147 | + <br> |
| 148 | + <div> |
| 149 | + <h3 class="govuk-heading-m" id="how-the-service-api-works">How the API works</h3> |
| 150 | + <div class="govuk-!-padding-bottom-3"></div> |
| 151 | + <div class="govuk-!-padding-bottom-3"></div> |
| 152 | + <p class="govuk-body">Body text</p> |
| 153 | + <div class="govuk-!-padding-bottom-3"></div> |
| 154 | + <div> |
| 155 | + <h3 class="govuk-heading-m" id="how-to-test-this-service-api">How to test this API</h3> |
| 156 | + <p class="govuk-body">HMLR has created a test environment for the Download a document API. We’ve also provided example code to demonstrate what you should expect when developing your own services.</p> |
| 157 | + <ul class="govuk-list"> |
| 158 | + <li> |
| 159 | + <p class="govuk-body"><a class="govuk-body govuk-link" href="./test-stubs">View |
| 160 | + Application information test stubs</a>.</p> |
| 161 | + </li> |
| 162 | + </ul> |
| 163 | + <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> |
| 164 | + <p class="govuk-body">For general testing guidance, visit our <a class="govuk-body govuk-link" |
| 165 | + href="/a-guide-to-testing">guide to testing</a>.</p> |
| 166 | + </div> |
| 167 | + </div> |
| 168 | + </div> |
| 169 | + <div class="govuk-grid-column-one-third"> |
| 170 | + <aside class="related-items" role="complementary"> |
| 171 | + <h2 class="govuk-heading-m" id="related-apis"> |
| 172 | + Related APIs |
| 173 | + </h2> |
| 174 | + <nav role="navigation" aria-labelledby="related-apis"> |
| 175 | + <ul class="govuk-list govuk-!-font-size-16"> |
| 176 | + <li> |
| 177 | + <a class="govuk-body govuk-link" href="/apis/submit-an-application-to-change-the-land-register"> |
| 178 | + Submit an application to change the Land Register |
| 179 | + </a> |
| 180 | + </li> |
| 181 | + <li> |
| 182 | + <a class="govuk-body govuk-link" href="/apis/send-a-document"> |
| 183 | + Send a document |
| 184 | + </a> |
| 185 | + </li> |
| 186 | + <li> |
| 187 | + <a class="govuk-body govuk-link" href="/apis/submit-an-application"> |
| 188 | + Submit an application |
| 189 | + </a> |
| 190 | + </li> |
| 191 | + <li> |
| 192 | + </li> |
| 193 | + <li> |
| 194 | + <a class="govuk-body govuk-link" href="/apis/notifications"> |
| 195 | + Notifications |
| 196 | + </a> |
| 197 | + </li> |
| 198 | + <li> |
| 199 | + <a class="govuk-body govuk-link govuk-!-font-weight-bold" href="/find-a-service-api"> |
| 200 | + More <span class="govuk-visually-hidden">in Subsection</span> |
| 201 | + </a> |
| 202 | + </li> |
| 203 | + </ul> |
| 204 | + </nav> |
| 205 | + </aside> |
| 206 | + </div> |
| 207 | +</div></div> |
| 208 | + |
| 209 | + </main> |
| 210 | + </div> |
| 211 | + |
| 212 | +<footer class="govuk-footer govuk-footer--hmlr " role="contentinfo"> |
| 213 | + <div class="govuk-width-container "> |
| 214 | + <div class="govuk-footer__meta"> |
| 215 | + <div class="govuk-footer__meta-item govuk-footer__meta-item--grow"> |
| 216 | + <h2 class="govuk-visually-hidden">These links open in a new tab.</h2> |
| 217 | + <ul class="govuk-footer__inline-list"> |
| 218 | + <li class="govuk-footer__inline-list-item"> |
| 219 | + <a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html"> |
| 220 | + Accessibility Statement |
| 221 | + </a> |
| 222 | + </li> |
| 223 | + </ul> |
| 224 | + <div class="govuk-footer__meta-custom"> |
| 225 | + These links open in a new tab. |
| 226 | + </div> |
| 227 | + </div> |
| 228 | + <div class="govuk-footer__meta-item"> |
| 229 | + <span |
| 230 | + class="govuk-footer__link govuk-footer__copyright-logo govuk-footer__copyright-logo--hmlr" |
| 231 | + >© Crown copyright</span> |
| 232 | + </div> |
| 233 | + </div> |
| 234 | + </div> |
| 235 | +</footer> |
| 236 | + |
| 237 | + </body> |
| 238 | +</html> |
0 commit comments