OS Docs Home OS NGD OS APIs OS Download Products More than Maps OS Data Hub

Styles

PreviousTiles NextGetting Started

Last updated 1 month ago

Was this helpful?

Retrieve the list of styles available from this service.

get

Path parameters

collectionIdstring · enumRequired

Local identifier of a collection

Possible values:

Responses

200

List of available styles.

application/json

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

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/styles HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "links": [
    {
      "href": "http://data.example.com/buildingpart/123",
      "rel": "alternate",
      "type": "application/geo+json",
      "templated": true,
      "varBase": "/ogcapi/vars/",
      "hreflang": "en",
      "title": "Building Part",
      "length": 1
    }
  ],
  "styles": [
    {
      "id": "text",
      "title": "text",
      "links": [
        {
          "href": "http://data.example.com/buildingpart/123",
          "rel": "alternate",
          "type": "application/geo+json",
          "templated": true,
          "varBase": "/ogcapi/vars/",
          "hreflang": "en",
          "title": "Building Part",
          "length": 1
        }
      ]
    }
  ]
}

Root level properties of a style specify the map's layers, tile sources and other resources, and default values for the initial camera position when not specified elsewhere.

get

Path parameters

collectionIdstring · enumRequired

Local identifier of a collection

Possible values:

styleIdstring · enumRequired

An identifier representing a specific style.

Possible values:

Responses

200

*/*

Responseobject

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

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/styles/{styleId} HTTP/1.1
Host: api.os.uk
Accept: */*

{}

Styling resources such as fonts and sprites

get

Path parameters

collectionIdstring · enumRequired

Local identifier of a collection

Possible values:

styleIdstring · enumRequired

An identifier representing a specific style.

Possible values:

resourceBaseNamestringRequired

Styling resourece base name.

Example: sprites

Responses

200

*/*

Responseobject

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

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/styles/{styleId}/{resourceBaseName}/** HTTP/1.1
Host: api.os.uk
Accept: */*

{}