Landing page

Retrieve the OS NGD API – Tiles landing page for this service.

get

Responses

200

The landing page provides links to the API definition (link relation service-desc, in this case path /api), to the Conformance declaration (path /conformance, link relation conformance), and to the Collections of geospatial data (path /collections, link relation data).

application/json

titlestringOptional

While a title is not required, implementors are strongly advised to include one.

Example: OS NGD API

descriptionstringOptionalExample: Ordnance Survey National Geographic Database API.

attributionstringOptional

The attribution should be short and intended for presentation to a user, for example, in a corner of a map. Parts of the text can be links to other resources if additional information is needed. The string can include HTML markup.

400

The request was not supported.

application/json

404

The requested resource does not exist on the server. For example, a path parameter had an incorrect value.

application/json

405

The HTTP method requested is not supported. This endpoint only supports 'GET' requests.

application/json

406

A request header value was not supported.

application/json

500

A server error occurred.

application/json

504

Gateway Timeout.

application/json

get

/

HTTPcURLJavaScriptPython

GET /maps/vector/ngd/ota/v1/ HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "title": "OS NGD API",
  "description": "Ordnance Survey National Geographic Database API",
  "links": [
    {
      "href": "http://data.example.org/",
      "rel": "self",
      "type": "application/json",
      "title": "this document"
    },
    {
      "href": "http://data.example.org/api?f=json",
      "rel": "service-desc",
      "type": "application/vnd.oai.openapi+json;version=3.0",
      "title": "the API definition"
    },
    {
      "href": "http://data.example.org/api",
      "rel": "service-doc",
      "type": "text/html",
      "title": "the API documentation"
    },
    {
      "href": "http://data.example.org/conformance",
      "rel": "conformance",
      "type": "application/json",
      "title": "OGC API conformance classes implemented by this service"
    },
    {
      "href": "http://data.example.org/collections",
      "rel": "data",
      "type": "application/json",
      "title": "Information about the collections"
    }
  ]
}