UK Data AtlasAPI

Get checks for a crosswalk

See the checks one crosswalk passed: its file is intact, its areas resolve and, for containment, every area has exactly one parent.

get
/validation/crosswalks/{crosswalk-id}

Path parameters

  • crosswalk-idstringrequired

    A crosswalk id, e.g. constituency-2010-to-2024-official-lookup-v2.

Returns

ValidationResourceEnvelope

The crosswalk'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.

Technical notes

Show the precise behaviour

Every crosswalk is checked for artifact integrity, resolvable endpoints, consistent source names and at least one target per source. Clean containment must give each source exactly one parent. Area overlap must have weights summing to 1, the coverage its adapter requires, and clear separation between slivers and real overlaps.