Terms of use
The terms of use policies explain what users can expect when creating and operating software services that use Business Gateway APIs.
Breaking change
A breaking change policy is currently being drafted and will be available here soon.
Bug fix releases
Notification of an emergency bug fix will be through the Service Desk. A new version number will be incorporated into an existing web service name that is being replaced, for example version 1.0 will become version 1.1.
In this emergency example, version 1.0 will be withdrawn as soon as version 1.1 becomes live.
A new version of the vendor test facility (stub) will go live at the same time as the web service itself. Integrated vendors will be notified if and/or when they can test the change before it is put live.
Information service schemas
Due to the impact of delivering new schemas, we will endeavour to schedule a maximum of one release per year. We will only replace a web service immediately if there is a major bug.
New web service
Notification of the functionality and delivery schedule of a new web service will be through standard customer communication channels and Business Gateway forum.
All technical details will be published in the Business Gateway developer pack.
A vendor test facility will go live at the same time as or prior to the web service itself. This will include test stubs, vendor test data, workflows providing business rules and message outputs and schema validation sheets.
Scheduled upgrade releases
Notification of the changes being made in a new version of an existing web service will be from the standard customer communication channels.
The new version will run simultaneously with the old, until the old version is deprecated, to avoid the need for all applications to perform a hard cutover.
A new version number will be incorporated into an existing web service name that is being replaced, for example version 1.0 (or 1.1) will become version 2.0.
A new version of the vendor test facility will go live at the same time as or prior to the new version of the web service.
Change details will be contained in the Service Business Gateway release notes on the Business Gateway landing page.
System security
All users of the network are responsible for maintaining up-to-date system patches, security updates, anti-virus software and other countermeasures to protect their systems.
Any software that could interact with HM Land Registry systems should be thoroughly tested and you must have your own testing procedures and policies in place and apply them rigorously.
Some free/beta programs can contain bugs or viruses, which could pose a threat to HM Land Registry systems. Applications and operating system software should only be implemented in operational systems after extensive and successful testing.
Testing should be done in a secure environment with non-sensitive data. Access to system files and program source code should be controlled.
Web service deprecation
Notification of the schedule for deprecation (removal) will come from the standard customer communication channels. The normal deprecation of a web service will be six months from the date of notification, but this may vary in exceptional circumstances.
All users of a service will receive a final reminder one month before the service is discontinued.
Changes and additions to the service will be contained in the Business Gateway service release notes. Change details relating to the developer pack will be contained in the Business Gateway Developer Pack release notes.
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.