diff --git a/app/views/apis/application-information-technical-guide.html b/app/views/apis/application-information-technical-guide.html index 70d49e0..26c59e3 100644 --- a/app/views/apis/application-information-technical-guide.html +++ b/app/views/apis/application-information-technical-guide.html @@ -187,51 +187,29 @@

GET /v0/applications/{id}/status - ACCE +
+ +
+

Related APIs

+ + -
- - - - -
{% endblock %} diff --git a/app/views/apis/application-information-test-stubs.html b/app/views/apis/application-information-test-stubs.html index 0b3d356..aca9e2f 100644 --- a/app/views/apis/application-information-test-stubs.html +++ b/app/views/apis/application-information-test-stubs.html @@ -203,6 +203,23 @@

Response

+
+

Related APIs

+ + diff --git a/app/views/apis/application-information.html b/app/views/apis/application-information.html index b824689..ef425dd 100644 --- a/app/views/apis/application-information.html +++ b/app/views/apis/application-information.html @@ -47,42 +47,7 @@

These API endpoints are not currently live. - - - +
@@ -107,6 +72,38 @@


Overview

+
+

How the API works

+
+

Interaction

+
+ + A diagram showing the interaction of the Application Information API. +

+

This diagram demonstrates how the Application information API works to support users.

+

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.

+

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.

+ +
+

State diagram

+
+ A diagram showing how the Application Information API works. +

+ +

The state diagram demonstrates how the validation process works once an application has been submitted.

+

When the system starts the validation process, there are several potential outcomes which can each trigger a different response. A response may include:

+ +

+ +
+
+ + +

View the technical guide

@@ -126,17 +123,6 @@

View the API specifi

- -
-

How the API works

-
-

Interaction

-
-A diagram showing the interaction of the Application Information API. -

State diagram

-
-A diagram showing how the Application Information API works. -

diff --git a/app/views/apis/notifications-technical-guide.html b/app/views/apis/notifications-technical-guide.html index 152e454..8573cc5 100644 --- a/app/views/apis/notifications-technical-guide.html +++ b/app/views/apis/notifications-technical-guide.html @@ -226,49 +226,26 @@

Acknowledge notifications response

+ +
+

Related APIs

+
-
- - - -
- diff --git a/app/views/apis/notifications-test-stubs.html b/app/views/apis/notifications-test-stubs.html index 1ecd6d6..7c7a29b 100644 --- a/app/views/apis/notifications-test-stubs.html +++ b/app/views/apis/notifications-test-stubs.html @@ -541,6 +541,23 @@

Response

+
+

Related APIs

+ + diff --git a/app/views/apis/notifications.html b/app/views/apis/notifications.html index 7fc7467..b9a3e47 100644 --- a/app/views/apis/notifications.html +++ b/app/views/apis/notifications.html @@ -47,46 +47,13 @@

These API endpoints are not currently live. - - +
+
@@ -104,6 +71,19 @@


Overview

+
+

How the API works

+
+ A diagram showing the interaction of the Notification API. + +

+

Notifications API

+

This diagram demonstrates how the Notifications API works to support users.

+

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.

+

A user can also notify HMLR that it has received notifications using the Acknowledge notifications API. The system will acknolwedge this notification.

+ +
+

View the technical guide

@@ -124,11 +104,6 @@

View the API specifi

-
-

How the API works

-
-A diagram showing the interaction of the Notification API. -

diff --git a/app/views/apis/send-a-document-technical-guide.html b/app/views/apis/send-a-document-technical-guide.html index 457c5b4..a27da76 100644 --- a/app/views/apis/send-a-document-technical-guide.html +++ b/app/views/apis/send-a-document-technical-guide.html @@ -321,47 +321,27 @@

POST /v0/documents/url - Response

  • HTTP 4xx on failure
    • -
    - -
    +
    - - +
    +

    Related APIs

    + + +
    -
    {% endblock %} diff --git a/app/views/apis/send-a-document-test-stubs.html b/app/views/apis/send-a-document-test-stubs.html index 99bf89d..e8d05b7 100644 --- a/app/views/apis/send-a-document-test-stubs.html +++ b/app/views/apis/send-a-document-test-stubs.html @@ -343,6 +343,23 @@

    Response

    +
    +

    Related APIs

    + + diff --git a/app/views/apis/send-a-document.html b/app/views/apis/send-a-document.html index e287aae..69e8098 100644 --- a/app/views/apis/send-a-document.html +++ b/app/views/apis/send-a-document.html @@ -48,41 +48,7 @@

    - - +
    @@ -106,6 +72,22 @@


    Overview

    +
    +

    How the API works

    +
    + A diagram showing how the Send a Document API works. + +

    Send a document API

    +

    This diagram demonstrates how the Send a document API works to support users.

    + +

    When the user sends the request to generate an upload URL, the HMLR system will respond with a URL that can be used to upload the document to.

    + +

    Users can then use this URL to upload the document to the system.

    + + + +
    +

    View the technical guide

    @@ -125,13 +107,6 @@

    View the API specifi

    - -
    -

    How the API works

    -
    -A diagram showing how the Send a Document API works. - -

    diff --git a/app/views/apis/submit-an-application-technical-guide.html b/app/views/apis/submit-an-application-technical-guide.html index 805de1e..8d9a135 100644 --- a/app/views/apis/submit-an-application-technical-guide.html +++ b/app/views/apis/submit-an-application-technical-guide.html @@ -7224,48 +7224,27 @@

    POST - /v0/applications - Transfer of P
    - +
    +

    Related APIs

    + +
    -
    - - -
    diff --git a/app/views/apis/submit-an-application-test-stubs.html b/app/views/apis/submit-an-application-test-stubs.html index 32eb9cb..153c55f 100644 --- a/app/views/apis/submit-an-application-test-stubs.html +++ b/app/views/apis/submit-an-application-test-stubs.html @@ -763,6 +763,23 @@

    Response

    +
    +

    Related APIs

    + + diff --git a/app/views/apis/submit-an-application-to-change-the-land-register.html b/app/views/apis/submit-an-application-to-change-the-land-register.html index d4e42c2..b3b4607 100644 --- a/app/views/apis/submit-an-application-to-change-the-land-register.html +++ b/app/views/apis/submit-an-application-to-change-the-land-register.html @@ -15,6 +15,13 @@ {% endblock %} +{% block pageScripts %} + +{% endblock %} + {% block beforeContent %} {{ govukPhaseBanner({ tag: { @@ -53,13 +60,18 @@

  • - - View the API specification + + How the API works
  • - - How the API works + + How to integrate the API: step by step + +
    • +
  • + + View the API specification
    • @@ -130,8 +142,30 @@

    Important changes


    +

    How the API works

    + +

    This diagram demonstrates how the Submit an application to change the land register group of APIs work to support users.

    + +A diagram showing the submit an application to change the Land Register API +
    + + +

    The Send a document API allows users to create an upload URL and use it to upload their documents to the HMLR system.

    + +

    Once uploaded, the Submit an application API allows the application (complete with documentation) to be submitted.

    + +

    After submitting their applications, users are then able to receive and acknowledge notifications about the submitted applications through the Notifications API. +

    + + +

    Finally, the application information API allows submitted applications to be reviewed or processed. Alternatively, users can return to receive notifications if they're not ready to proceed. +

    + + + +
    -

    The new service will have endpoints to support:

    +

    How to integrate the Submit an application to change the land register API: step by step

    @@ -139,7 +173,153 @@

    Important changes

    These API endpoints are not currently live.
    - #}

    View API specification

    @@ -160,52 +340,8 @@

    View API specificati - - -

    How the API works

    - - A diagram showing the submit an application to change the Land Register API - -
    - - - -
    diff --git a/app/views/apis/submit-an-application.html b/app/views/apis/submit-an-application.html index 3a567bd..41eb04e 100644 --- a/app/views/apis/submit-an-application.html +++ b/app/views/apis/submit-an-application.html @@ -46,41 +46,7 @@

    These API endpoints are not currently live. - - +
    @@ -113,6 +79,19 @@


    Overview

    +
    +

    How the API works

    +
    + A diagram showing how the Submit an application API works. +
    +
    +

    Submit an application API

    +

    This diagram demonstrates how the Send a document API works to support users.

    + +

    When a user submits information to update the register, the HMLR system will respond by sending a unique application ID. Users can use this ID to receive information about the status of their application.

    + +
    +

    View the technical guide

    @@ -132,12 +111,6 @@

    View the API specifi

    - -
    -

    How the API works

    -
    -A diagram showing how the Submit an application API works. -

    diff --git a/app/views/find-a-service-api.html b/app/views/find-a-service-api.html index b386d8b..050f4c1 100644 --- a/app/views/find-a-service-api.html +++ b/app/views/find-a-service-api.html @@ -113,7 +113,7 @@

    Find an API

    -{# Application Enquiry +Application Enquiry SOAP API

    Use this service to view applications that are not yet completed by HMLR.

    -Discharge Activity +Discharge Activity SOAP API

    Use this service to check if any charges have been removed in the previous 30 days.

    -e-Document Registration Service +e-Document Registration Service SOAP API

    Use this service to send applications to change the register, automate the collection of correspondence and responses and receive completed applications.

    -Estimated Completion Date +Estimated Completion Date REST API

    The Estimated Completion Date (ECD) is a date by which the application is likely to be completed.

    -Land Charges Bankruptcy Search +Land Charges Bankruptcy Search SOAP API

    Use this service to find bankruptcy details on the Land Charges Register.

    -Land Charges Full Search +Land Charges Full Search SOAP API

    Use this service to request an official search of the Land Charges Register.

    -Local Land Charges Search +Local Land Charges Search SOAP API -

    Use the Local Land Charges service to find details of entries relating to land or property.

    #} +

    Use the Local Land Charges service to find details of entries relating to land or property.

    -Notifications + +Official Copy Document Availability V1 REST API

    Use this service to order the Official Copy Document.

    -Official Copy Document Availability V2 +Official Copy Document Availability V2 REST API

    Use this service to order the Official Copy Document.

    -Official Copy Title Known +Official Copy Title Known SOAP API

    Use this service to order an official copy of the register, title plan, conveyance referred to on the register, deed referred to on the register and lease.

    -Official Search of Whole (with Priority) +Official Search of Whole (with Priority) SOAP API

    Use this service when your application relates to the whole of the registered title to protect transfers, leases and mortgages.

    -Official Search of Whole (with Priority) with Data +Official Search of Whole (with Priority) with Data REST API

    Use this service when your application relates to the whole of the registered title to protect transfers, leases and mortgages.

    -Official Search of Part +Official Search of Part SOAP API

    Use this service when your application relates to the whole of the registered title to protect transfers, leases and mortgages.

    -Online Owner Verification +Online Owner Verification SOAP API -

    Use this service to verify property ownership data against HMLR property titles in real time.

    #} -{# -Outstanding Requests Service +

    Use this service to verify property ownership data against HMLR property titles in real time.

    + +    Outstanding Requests Service SOAP API

    Use this service to submit a request to return (or obtain) a list of applications with a new response to collect.

    -Poll Request Service +Poll Request Service SOAP API

    Use this service to collect responses for applications that have been manually processed or submitted outside of working hours.

    -Search by Property Description +Search by Property Description SOAP API

    Use this service to find out the title number and tenure of a property based on the address supplied.

    -Search of the Index Map +Search of the Index Map SOAP API -

    Use this service to find out if land is registered and to get the title number.

    #} +

    Use this service to find out if land is registered and to get the title number.

    Submit an application to change the Land Register REST API

    Use this service to help lodge applications with HMLR to update the register or create a new lease or transfer of part.

    -{# Register Extract Service +Register Extract Service SOAP API

    Use this service to get source data from the Land Register in an electronic data stream (alongside the usual supply of the official copy).

    -Registered Proprietor Names +Registered Proprietor Names REST API -

    Use this service to check the name and type of registered proprietors of a registered title throughout the process from instruction to application submission.

    #} +

    Use this service to check the name and type of registered proprietors of a registered title throughout the process from instruction to application submission.

    diff --git a/app/views/homepage.html b/app/views/homepage.html index 6b80cb0..eef91d5 100644 --- a/app/views/homepage.html +++ b/app/views/homepage.html @@ -77,9 +77,11 @@

    Create web services using Busin
    -
    + +

    -
    + +
    @@ -96,17 +98,17 @@

    Get st
    -

    What to expect from the developer pack

    +

    What to expect from the developer pack

    Includes who this guide is for and how to use it

    -

    How to access Business
    Gateway

    +

    How to access Business
    Gateway

    How we help businesses integrate with HM Land Registry (HMLR)

    -

    Terms of use

    +

    Terms of use

    Our Business Gateway policies and practices

    @@ -117,17 +119,17 @@

    Explor
    -

    Learn about the APIs we use

    +

    Learn about the APIs we use

    A breakdown of API types and when to use them

    -

    Find an API

    +

    Find an API

    Choose the right API to integrate HMLR servicesm

    -

    A guide to testing

    +

    A guide to testing

    Includes information on testing best practice

    @@ -137,9 +139,10 @@

    Support

    -

    Tell us how we can improve Business Gateway and join our community.

    -

    This developer pack is maintained by HMLR. If you’ve got a question, idea or suggestion, you can contact us.

    -
    +

    Tell us how we can improve Business Gateway and join our community.

    +

    This developer pack is maintained by HMLR. If you’ve got a question, idea or suggestion, you can contact us.

    +

    We sometimes use technical terms to describe the work we do at HMLR. For a list of commonly used terms and their definitions, visit our glossary.

    +

    diff --git a/app/views/what-to-expect-from-the-developer-pack.html b/app/views/what-to-expect-from-the-developer-pack.html index 0504f62..9ca6a64 100644 --- a/app/views/what-to-expect-from-the-developer-pack.html +++ b/app/views/what-to-expect-from-the-developer-pack.html @@ -117,9 +117,9 @@

    What to expect from the developer pack

    If you are new to Business Gateway and would like an overview of how it works, you may find it useful to explore the Before you start section first.

    If you are looking for specific service and API information, you may find it useful to jump straight to the Explore APIs section.

    -
    +
    diff --git a/package-lock.json b/package-lock.json index 9fbdf75..e2469d0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,7 @@ "": { "dependencies": { "@govuk-prototype-kit/common-templates": "2.0.1", - "@govuk-prototype-kit/step-by-step": "2.2.3", + "@govuk-prototype-kit/step-by-step": "^2.2.3", "@ministryofjustice/frontend": "^3.3.1", "govuk-frontend": "5.8.0", "govuk-prototype-kit": "13.16.2", diff --git a/package.json b/package.json index cb16102..b130d16 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ }, "dependencies": { "@govuk-prototype-kit/common-templates": "2.0.1", - "@govuk-prototype-kit/step-by-step": "2.2.3", + "@govuk-prototype-kit/step-by-step": "^2.2.3", "@ministryofjustice/frontend": "^3.3.1", "govuk-frontend": "5.8.0", "govuk-prototype-kit": "13.16.2",