LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsOS Data Hub
  • Introduction to OS APIs
  • Core Concepts
    • Getting started with an API project
    • Authentication
    • Error codes
    • Rate-limiting policy
    • OS API branding
    • Service level agreements
    • Service availability dashboard
  • Accessing OS APIs
    • OS Maps API
      • Layers and styles
      • Getting started
        • ESRI ArcGIS Online
        • ESRI ArcGIS Pro
        • ESRI ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • ZXY
        • WMTS
      • Code examples
    • OS Vector Tile API
      • What data is available?
      • Getting started
        • ESRI ArcGIS Pro
        • Cadcorp SIS
        • QGIS
        • Create a web application using the OS Vector Tile API
      • Technical specification
        • Service Metadata
        • Stylesheet
        • Tile request
      • Code examples
      • Stylesheets
    • OS NGD API – Tiles
    • OS NGD API – Features
    • OS Features API
      • OS Product Archive
      • What data is available?
      • Getting started
        • ArcGIS Online
        • ArcGIS Pro
        • ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • getCapabilities
        • describeFeatureType
        • getFeature
        • Filtering
        • Paging
        • Empty values
      • Code examples
    • OS Names API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Nearest
      • Code list
      • Code examples
    • OS Linked Identifiers API
      • What data is available?
      • Getting started with implementing a look-up application
      • Technical specification
        • Identifier
        • Identifier Types
        • Feature Types
        • Product Version Information
      • Code examples
    • OS Places API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Postcode
        • UPRN
        • Nearest
        • BBOX
        • Radius
        • Polygon
      • Datasets
      • Code lists
      • Code examples
    • OS Match & Cleanse API
      • End of Life Information
      • Getting started with an example match query using Node.js
      • Technical specification
      • Datasets
      • Code lists
    • OS Downloads API
      • Getting started
        • Automating OS OpenData downloads
        • Automating OS Premium data downloads
      • Technical specification
        • OpenData products
        • OpenData product details
        • Download an OpenData product
        • OpenData product image
        • Data packages
        • Data package ID
        • Data package version
        • Data package version ID
        • Download a data package
    • OAuth 2 API
      • Getting started
      • Technical specification
  • Additional resources
    • OS API Wrappers
      • JavaScript
      • Python
      • R
  • Extra Links
    • Accessibility
    • Contact us
    • PSGA Product Summary
    • Terms and conditions
Powered by GitBook
On this page

Was this helpful?

  1. Accessing OS APIs
  2. OS Linked Identifiers API
  3. Technical specification

Identifier Types

PreviousIdentifierNextFeature Types

Last updated 1 month ago

Was this helpful?

Queries ID when input identifierType is known

get

Returns associated Linked Identifiers, when the input identifier type is known. Returns an object.

Authorizations
Path parameters
idstring · min: 1 · max: 36Required

ID of the feature that is being matched

identifierTypestring · enumRequired

Identifier 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
GET /search/links/v1/identifierTypes/{identifierType}/{id} HTTP/1.1
Host: ${lids.api.server}
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"
        }
      ]
    }
  ]
}