An Application Programming Interface for the Local Land Charges Registration Service. The API receives LLC data in JSON format from either the llc-frontend or through HTTP requests and sends the data on to the llc-register.
The API is a Flask/Python application that serves as an Interface to the llc-register. The API provides RESTful routes for pushing LLC data to the register. Data is validated using JSON Schema and RAML.
- Local Land Charges Register
- Statutory Provisions Register
- Registering Authorities Register
- Further Information Location Register
- Geo Spatial Search
- Curies
The API provides four interfaces to the four registers of the Local Land Charges Service. The API implements the GDS Registers specification, allowing users to create new records and update existing records.
Environment Variables:
To add environment variables that can be accessed by your application add the relevant entry to the docker-compose.yml file under the corresponding application, under the environment definitions.
RAML documentation: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/local-land-charge.raml
To create a new Local land charge record it must conform to the following Schema: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/local-land-charge.json
GET local-land-charge/records -- retrieves all Local Land Charge records currently in the register
GET local-land-charge/record/<id-number> -- retrieves a specific record by the id number
POST local-land-charge/records/ -- creates a new record in the register. Data supplied as JSON reflecting the schema
PUT local-land-charge/record/<id-number> -- update the record specified by the id number. Data supplied as JSON reflecting the schema
RAML documentation: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/statutory-provision.raml
To create a new statutory provision record it must conform to the following Schema: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/statutory-provision.json
GET statutory-provision/records -- retrieves all Statutory Provision records currently in the register
GET statutory-provision/record/<id-number> -- retrieves a specific record by the id number
POST statutory-provision/records/ -- creates a new record in the register. Data supplied as JSON reflecting the schema
PUT statutory-provision/record/<id-number> -- update the record specified by the id number. Data supplied as JSON reflecting the schema
RAML documentation: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/llc-registering-authority.raml
To create a new registering authority record it must conform to the following Schema: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/llc-registering-authority.json
GET llc-registering-authority/records -- retrieves all Registering Authority records currently in the register
GET llc-registering-authority/record/<id-number> -- retrieves a specific record by the id number
POST llc-registering-authority/records/ -- creates a new record in the register. Data supplied as JSON reflecting the schema
PUT llc-registering-authority/record/<id-number> -- update the record specified by the id number. Data supplied as JSON reflecting the schema
RAML documentation: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/further-information-location.raml
To create a new further information location record it must conform to the following Schema: http://www.landregistryconcept.co.uk/api-docs/schemas/llc/further-information-location.json
GET further-information-location/records -- retrieves all Registering Authority records currently in the register
GET further-information-location/record/<id-number> -- retrieves a specific record by the id number
POST further-information-location/records/ -- creates a new record in the register. Data supplied as JSON reflecting the schema
PUT further-information-location/record/<id-number> -- update the record specified by the id number. Data supplied as JSON reflecting the schema
The API also has an endpoint for geometry functions to search the Geo-Spatial index on the Local Land Charges Register: For all functions the geometry data is supplied as GeoJSON in the body of the request.
It is advised that searches should default to intersects as this will return all records that are contained, overlaping or touching the search area.
POST local-land-charge/record/geometry/intersects -- Return all geometries whose edges intersect with the supplied geometry
POST local-land-charge/record/geometry/within -- Return all geometries that the supplied geometry is completely within
POST local-land-charge/record/geometry/contains -- Return all geometries that are completely contained by the supplied geometry
POST local-land-charge/record/geometry/equals -- Return all geometries that are exactly equal to the supplied geometry
POST local-land-charge/record/geometry/overlaps -- Return all geometries that overlap the supplied geometry
POST local-land-charge/record/geometry/touches -- Return all geometries whose edges touch with the supplied geometry
All records are return with embedded CURIE links. To have the CURIE links resolved an optional resolve parameter that can be supplied. Append one of the above queries with
?resolve=1 -- Result will have all CURIE links resolved with correct data
sdjoifejiofe ujiojioji