Skip to main content

DataSetGetQueryLocations

The location option criteria to filter results by in a data set GET query.

The results can be matched by either the location option’s ID or a code. Note the following differences:

  • IDs only match a single location
  • Codes may match multiple locations

Whilst codes are generally unique to a single location, they can be used for multiple locations. This may match more results than you expect so it’s recommended to use IDs where possible.

Properties

Property Type Required Description
eq string false

Filter the results to be in this location.

notEq string false

Filter the results to not be in this location.

in array (string) false

Filter the results to be in one of these locations.

notIn array (string) false

Filter the results not to be in one of these locations.

Example schema

{
  "eq": "NAT|id|3dCWP",
  "notEq": "REG|code|E12000003",
  "in": [
    "LA|code|E08000003",
    "LA|oldCode|373"
  ],
  "notIn": [
    "SCH|urn|123456",
    "SCH|laEstab|1234567"
  ]
}