Location List
Endpoint for interacting with locations.
Query parameters
uuid:
Text filter on uuid
. Field filter method exact
is supported.
name:
Text filter on name
. Field filter methods exact
, startswith
are supported.
code:
Text filter on code
. Field filter methods exact
, startswith
are supported.
access_modifier
Filter on access_modifier
, options are 'Public', 'Private', 'Common', or 'Hidden'.
created:
Temporal filter on created
. Supports various lookup types
(exact
, lt
, lte
, gt
, gte
; created__exact by default).
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
last_modified:
Temporal filter on last_modified
. Supports various lookup types
(exact
, lt
, lte
, gt
, gte
; last_modified__exact by default).
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
timeseries__start:
Temporal filter on start
field of the related timeseries. Supports
various lookup types (exact
, lt
, lte
, gt
, gte
;
timeseries__start__exact by default). Filter values should be specified in
ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
timeseries__end:
Temporal filter on end
field of the related timeseries. Supports
various lookup types (exact
, lt
, lte
, gt
, gte
;
timeseries__end__exact by default). Filter values should
be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
organisation__uuid
Text filter on organisation__uuid
. Field filter method exact
is supported.
geom_isnull:
Boolean filter on geometry
.
geom_within:
Spatial filter on geometry
. Supports WKT, HEXEWKB, and GeoJSON.
object_id:
Number filter on the id
attribute of an object
.
Field filter method exact
is supported.
To be used in combination with object_type.
object__id:
Numerical filter on object__id
. Field filter method exact
is supported.
object__type:
Text filter on object__type
. Field filter methods exact
is supported.
ordering:
Offers basic ordering functionality on the name
and last_modified
attribute of
locations. Orderings may be reversed by prefixing the attribute with
'-'.
page: To prevent system overloads, list-view results are paginated. This parameter specifies which page to return.
page_size: The maximum number of results to return in list-view. The default is 10.
Examples
?name__startswith=gemaal
?name=gemaal
?code=ABC
?code__startswith=A
?timeseries__start__gte=2017-01-01T00:00:00Z
?timeseries__end__lt=2018-01-01T00:00:00Z
?organisation__uuid=b10eaf1f-2867-4ffb-8f4a-5eb9bd37dbf1
?access_modifier=Private
?access_modifier=100
?created__gte=2017-01-01T00:00:00Z
?last_modified__lt=2018-01-01T00:00:00Z
?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]]]}
?object__id=1
?object__type=building
?ordering=name
GET /api/v4/locations/?code=3201_PS2&name__startswith=inlaat
https://demo.lizard.net/api/v4/locations/5fa58247-5f14-44ea-b8a7-352c4e0a3832/", "uuid": "5fa58247-5f14-44ea-b8a7-352c4e0a3832", "name": "inlaat peilbeheer", "code": "3201_PS2", "geometry": null, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": null, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-08-29T11:45:43.752672Z", "last_modified": "2022-01-18T08:23:05.259378Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/653b6a8e-5e76-4de8-b6e9-00b57fc24e36/", "uuid": "653b6a8e-5e76-4de8-b6e9-00b57fc24e36", "name": "inlaat peilbeheer", "code": "3201_PS2", "geometry": null, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "object": null, "access_modifier": "Public", "extra_metadata": {}, "created": "2015-08-28T14:41:32.085885Z", "last_modified": "2023-06-27T09:30:39.573044Z", "last_modified_by": "karl.schutt" } ] }{ "count": 2, "next": null, "previous": null, "results": [ { "url": "