UK Data AtlasAPI

Validate a whole column

Validate up to 250,000 area codes or names from a JSON or CSV request body before joining data to a boundary release.

post
/areas:validate

Good to know

  • Use this POST endpoint when the column is too long for the GET endpoint's repeated value query parameter.

Query parameters

  • geographystringoptional

    As on the GET. Supply with release, or omit both to infer a likely compiled release.

  • releasestringoptional

    As on the GET. Supply with geography, or omit both to infer a likely compiled release.

Returns

Envelope

A result for every value, in input order, and a summary, as the GET gives.

  • apiVersionv1required
  • atlasReleasestringrequired

    The immutable /atlas-release releaseId for the artifacts that produced this response.

  • metaobjectrequired
    Show1 child field
    • nextCursorstring | nullrequired

      Opaque cursor for the next page, or null at the end.

When it goes wrong

  • 400The body cannot be read as rows, or a parent is missing for some rows.
  • 404No resource matches that identity.
  • 413The body is larger than 8 MiB, or holds more than 250,000 rows.
  • 415The body is declared as neither JSON nor CSV. A body sent as form-urlencoded, as curl does by default, or with no type is read as JSON when it opens with { or [, and as CSV otherwise.

Every error has the same shape. See Errors for how to handle them.

Technical notes

Show the precise behaviour

The same check as the GET, for a column longer than a URL holds: up to 250,000 values in an 8 MiB body. Send JSON, {"values": ["E05000650", "Bristol"], "parents": [...]} or {"rows": [{"area": "Bristol", "parent": "..."}]}, or CSV with a header row naming the column area, code, name or value, and optionally a parent column. geography and release stay in the query, as on the GET, and the answer is exactly the GET's for the same values. It is never cached, since it depends on the body.