Feature types

API test authentication

The Open API block allows you to test OS APIs directly from the page with example data and parameters. To use this feature, you will need to add your API Key or OAuth2 token to the authentication field.

For help generating an API Key or OAuth2 token, please see the Getting started with an API project or OAuth2 documentation.

Query ID when input featureType is known

get

Returns associated Linked Identifiers, when feature type is known. Returns an object.

Authorizations

ApiKeyAuthOAuth2

keystringRequired

Path parameters

idstring · min: 1 · max: 36Required

ID of the feature that is being matched

featureTypestring · enumRequired

Feature type of ID being queried

Possible values:

Responses

200

Search results matching criteria

application/json

400

E.g. missing query parameter, malformed syntax.

401

The client has not provided authentication or incorrect authentication.

403

The client has authenticated its access but does not have sufficient rights to complete the request.

404

The server has not found anything matching the Request-URI.

405

Request used an unsupported HTTP method, e.g. DELETE or PUT.

429

Exceeded the number of requests per minute (rate-limit).

500

Generic internal server error.

503

Temporary outage due to overloading or maintenance.

get/featureTypes/{featureType}/{id}

HTTPcURLJavaScriptPython

GET /search/links/v1/featureTypes/{featureType}/{id} HTTP/1.1
Accept: */*

{
  "linkedIdentifier": {
    "identifier": "text",
    "featureType": "BLPU",
    "identifierType": "GUID"
  },
  "correlations": [
    {
      "searchedIdentifierVersionDate": "text",
      "searchedIdentifierVersionNumber": 1,
      "correlationMethodIdentifier": "RoadLink_TOID_TopographicArea_TOID_2",
      "correlatedFeatureType": "BLPU",
      "correlatedIdentifierType": "GUID",
      "correlatedIdentifiers": [
        {
          "identifier": "text",
          "versionNumber": 1,
          "versionDate": "text",
          "confidence": "text",
          "correlationIdentifier": "text"
        }
      ]
    }
  ]
}