UK Data AtlasAPI

Get checks for boundaries

See the checks one boundary release went through before it was published.

get
/validation/boundary-releases/{geography}/{release}

Path parameters

  • geographystringrequired

    A geography type id, e.g. constituency or ward.

  • releasestringrequired

    A boundary release id, e.g. 2024-07-uk-bgc, or latest for the geography's newest release: the one /boundary-releases:resolve chooses for the furthest date. A response to latest names the release it read in Content-Location. A geography whose newest month holds several releases that differ in more than coverage, or that has a release whose id carries no month, is refused with 409 and the releases that could be newest.

Returns

ValidationResourceEnvelope

The boundary release's checks.

  • 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.

  • dataValidationResourcerequired
    Show4 child fields
    • idstringrequired

      atlas for checks across the Atlas's own artifacts; otherwise the validated resource's API path, such as crosswalks/{crosswalk-id}. A measure source partition is identified by the export that serves it, as exports/{export-id}.

    • kindenumrequired
      One ofatlasboundary-releasecrosswalkmeasuremeasure-source
    • statusenumrequired

      waived when any of its checks is waived.

      One ofpassedwaived
    • checksValidationCheck[]required
      Show5 child fields
      • idenumrequired
        One ofregistry-linksrelease-coveragelicence-recordedarea-identitiesgeometry-servablegeometry-positionedcandidates-reviewedartifact-integrityendpoints-verifiedsource-names-consistenttargets-presentsingle-parentweights-sum-to-onearea-coveragesliver-separationcontinuity-extentpopulation-coveragecontainment-verifiedbest-fit-verifiedmeasure-definitionrecords-resolvecountries-declaredvalues-validcomponents-sum-to-total
      • statusenumrequired
        One ofpassedwaived
      • detailstringoptional

        What the check found. Present on every waived check.

      • measuredobjectoptional

        Figures the check measured, whether it passed or not.

      • waiverobjectoptional
        Show1 child field
        • reasonstringrequired

When it goes wrong

  • 404No resource matches that identity.
  • 503The referenced build artifact has not been built yet.

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