Vepler logo
v2.116.0 Breaking change

Planning extractions, document type split, and Local Planning Authority in geography

Planning applications can now return citation-backed structured extractions via include=extractions. Document type is split into category and detailed sub-type, and address geography now carries the Local Planning Authority.

Added

  • Planning applications can now return structured, citation-backed extractions. Pass include=extractions on GET /v1/planning/{applicationIds} and GET /v1/planning/sources/{sourceIds}, or send "include": ["extractions"] in the body of POST /v1/planning/query, to attach an extractions object to each application.
  • The extractions object holds sub-extractions for decision, development, s106, officerAssessment and consulteeResponses. Each field is cited back to the source document, and each sub-extraction reports a verification status of verified (checked by the verifier) or extracted (machine-extracted, not yet checked). Sub-extractions are null when that data was not extracted; the object is omitted entirely unless requested.
  • Address geography now includes the Local Planning Authority. When you request include=geography on GET /v1/address/postcodes/{postcode} or GET /v1/address/uprn/{uprn}, the geography object now carries an lpa code/name pair. This can differ from district for National Parks, mayoral development corporations and joint planning boards.

Changed

  • Planning documents now describe their type with two fields instead of one. The single type field on each document in the documents array has been removed and replaced by documentCategory (broad category, e.g. drawing_plan, decision) and documentTypeDetailed (specific sub-type, e.g. floor_plan, decision_notice). This affects the document objects returned by all three planning endpoints.

Affected endpoints

← All changes