co-cddo / api-catalogue

The list of APIs in Government

Home Page:https://www.api.gov.uk

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HM Land Registry: Estimated Completion Date

SPD-LR opened this issue · comments

commented

Please fill in the following information:

**Base URL: https://businessgateway.landregistry.gov.uk/bg2/api/v1/applications/{application_reference}/estimate-completion-date

**
The URL for the API. For example, https://www.gov.uk/api/content. Please limit this to one URL - if you have sandbox environments or multiple endpoints please add them to the description.

**Name: Estimated Completion Date

The name of the API. For example, Gov.uk Content.

**Description:

Overview

The Estimated Completion Date (ECD) is a date by which the application is likely to be completed. It is not based on the individual application but is an estimate of when the majority (90%) of that application type will be completed.

In order to retain parity with our Portal customer experience, we require that anyone integrating with this service refer to the estimated completion timeframes which can be found at https://www.gov.uk/guidance/hm-land-registry-estimated-completion-timeframes. We also see benefit in end users being familiar with the above URL, the insights provided are likely to reduce the need for customer contact. Therefore we also ask that you make your customers aware of the above URL.

The ECD:

  • Is calculated on and from the day an application is received by HMLR.
  • May take up to an hour to be displayed after application submission.
  • Is updated every 30 calendar days until the application is completed or cancelled.
  • Is updated if HMLR correspondence is issued (first item of correspondence only).

For test endpoint, replace https://businessgateway.landregistry.gov.uk/bg2 with https://bgtest.landregistry.gov.uk/bg2test

**

The description of what the API is about. Please make this as detailed as possible to help users search. For example "GOV.UK Content API makes it easy to access the data used to render content on https://www.gov.uk. For any page hosted on GOV.UK you can use the path to access the content and associated metadata for a page."

**Documentation URL: https://landregistry.github.io/bgtechdoc/services/estimated_completion_date/

**
The URL for the API documentation. For example https://content-api.publishing.service.gov.uk/

**Maintainer: channelpartners@landregistry.gov.uk

**
Contact details for the team who manage the API, and who will be the first point of contact for a user wishing to access the service. Please don't use an individual's email address.

**Provider: HM Land Registry

**
The full name of the department or organisation who provide the API. For example 'Government Digital Service'.

Area Served:
Optional - The geographic area that the API serves. For example: 'Greater London'.

Start Date:
Optional - The date the API comes into service. For example: '2020-07-01'.

End Date:
Optional - The date the API will be retired. For example: '2022-07-01'.

Alternate Name:
Optional - the acronym of the department or organisation. For example: 'GDS'.

**Provider URL: https://www.gov.uk/government/organisations/land-registry

**
Optional - the canonical URL of the website of the department or organisation. For example: 'https://www.gov.uk/government/organisations/government-digital-service'.

If you have multiple APIs to add, you can use a CSV template with these fields which is available at: https://raw.githubusercontent.com/co-cddo/api-catalogue/HEAD/data/apic-csvtemplate.csv

Optionally, if you have more information you want to share with the API Catalogue community, please add it below.