Skip to main content

DataSetQueryLocationProviderUkprn

A provider (identified by its UKPRN) to filter results by.

Properties

Property Type Required Description
ukprn string true

The UKPRN (UK provider reference number) of the provider. This is typically an 8-digit number.

Validation constraints:

  • Maximum length: 20
  • Minimum length: 1
level GeographicLevelCode true

The geographic level of the provider. Must be set to PROV.

Validation constraints:

  • Minimum length: 1

Example schema

{
  "ukprn": "123454678",
  "level": "PROV"
}