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. Core Concepts

Error codes

Ordnance Survey uses standard HTTP response codes to provide key information on the outcome of API requests. These codes serve as a straightforward means of communication, indicating the success or failure of each API request between your application and our APIs.

When a request is successful, you'll encounter codes within the 2xx range. If the information in the request is incorrect (for example, missing query parameters), you'll receive codes within the 4xx range, and 5xx codes indicate an error with the OS APIs.

The following table details the HTTP response codes and their meaning within the context of OS APIs:

Code
Official description
Explanation in context of the API

200

OK

Request has been successful.

304

Not Modified

In response to a conditional GET request this response indicates that the underlying data has not changed since the previous request, and cached results may be re-used.

400

Bad request

For example, missing query parameter or malformed syntax.

401

Unauthorized

The client has not provided authentication or has provided incorrect authentication.

403

Forbidden

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

404

Not found

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

405

Method not allowed

The request used an unsupported HTTP method, for example, DELETE or PUT.

429

Too many requests

The number of requests per minute (rate-limit) has been exceeded.

500

Internal server error

A generic internal server error occurred.

503

Service unavailable

A temporary outage due to overloading or maintenance.

PreviousAuthenticationNextRate-limiting policy

Last updated 1 year ago

Was this helpful?