Location Instance

Endpoint for interacting with locations.

Query parameters

created: Temporal filter on created. Supports created__icontains, created__iexact, created__gte, created__gt, created__lt, created__lte, created__startswith. (created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

dist: Spatial filter on geometry. Also requires a point in (lon, lat) format. Distances, in meters, are internally converted to degrees. This conversion is approximate (and worse for high latitudes).

geom_isnull: Boolean filter on geometry.

geom_within: Spatial filter on geometry. Supports WKT, HEXEWKB, and GeoJSON.

in_bbox: Spatial filter on geometry. The bounding box format is: min Lat, min Lon, max Lat, max Lon. Includes locations that overlap the bounding box.

locationName: Text filter on name. Supports locationName__icontains, locationName__startswith lookup types(name__exact by default).

locationCode: Text filter on code. Supports locationCode__icontains, locationCode__startswith lookup types (locationCode__exact by default).

object_id: Number filter on the id attribute of an object. Supports object_id__icontains, object_id__startswith lookup types (object_id__exact by default). To be used in combination with object_type.

object_type: Related filter on object. See below for an example on how to filter on assets like sluices, pump stations, etc.

ordering: Offers basic ordering functionality on the name attribute of locations. Orderings may be reversed by prefixing the attribute with '-'.

organisation: Related filter on organisation. See the organisations endpoint.

organisation_code (or just code for short): Text filter on code. Supports organisation_code__icontains, organisation_code__exact, organisation_code__startswith lookup types (organisation_code__exact by default).

page: To prevent system overloads, list-view results are paginated. This parameter specifies which page to return.

pageSize: The maximum number of results to return in list-view. The default is 10.

point: See dist.

locationId: Text filter on uuid. Supports a comma-separated list of (fragments of) UUIDs. Supports locationId__icontains and locationId__iexact as default.

Examples

?created__gte=2017-01-01T00:00:00Z

?dist=1000&point=4.87,52.73

?geom_isnull=false

?geom_within=POLYGON((4.87 52.73, 4.87 52.79, 4.98 52.79, 4.98 52.73,
4.87 52.73))

?geom_within={"type": "Polygon", "coordinates": [[[4.87, 52.73],
[4.87, 52.79], [4.98, 52.79], [4.98, 52.73], [4.87, 52.73]]]}

?in_bbox=4.86,52.73,4.98,52.79

?locationName__icontains=gemaal

?object_type__model=sluice

?object_type__model=pumpstation&object_id=1

?ordering=name

?organisation__name=Noorderzijlvest

?organisation_code__startswith=WNS1400

?locationId__icontains=67035326-c5e3-41d2-ba7a-0bd4b8626b29