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/?format=api
{ "count": 59715, "next": "https://demo.lizard.net/api/v4/locations/?format=api&page=2", "previous": null, "results": [ { "url": "https://demo.lizard.net/api/v4/locations/faa84a55-cb8d-460c-a8b8-18d2b59da28c/?format=api", "uuid": "faa84a55-cb8d-460c-a8b8-18d2b59da28c", "name": "SAP verhard", "code": "3201_gw1", "geometry": null, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": null, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-08-29T11:45:36.639095Z", "last_modified": "2022-01-18T07:39:17.673642Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/619e1863-886f-4b1f-ad70-a975143c8332/?format=api", "uuid": "619e1863-886f-4b1f-ad70-a975143c8332", "name": "SAP Oost", "code": "3201_gw3", "geometry": null, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": null, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-08-29T11:45:37.976927Z", "last_modified": "2022-01-18T07:35:27.733807Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/ed874824-d20f-4ba1-a332-f0c3f92738fa/?format=api", "uuid": "ed874824-d20f-4ba1-a332-f0c3f92738fa", "name": "Inlaat sGravelandseVaart", "code": "3201_PS1", "geometry": null, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": null, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-08-29T11:45:43.186378Z", "last_modified": "2022-01-18T07:39:11.497003Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/5fa58247-5f14-44ea-b8a7-352c4e0a3832/?format=api", "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/?format=api", "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/7661fb46-293b-44b1-baae-707b577ef744/?format=api", "uuid": "7661fb46-293b-44b1-baae-707b577ef744", "name": "uitlaat peilbeheer", "code": "3201_PS3", "geometry": null, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": null, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-08-29T11:45:44.525605Z", "last_modified": "2022-01-18T07:37:49.831156Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/ea1084be-eb6e-4800-95b7-25f2cdbfe94f/?format=api", "uuid": "ea1084be-eb6e-4800-95b7-25f2cdbfe94f", "name": "Blokdijk West", "code": "KGM-Q-31595", "geometry": { "type": "Point", "coordinates": [ 5.124763259163939, 52.65208344541993, 0.0 ] }, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": { "id": 6523, "type": "pumpstation" }, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-11-05T10:24:21.773227Z", "last_modified": "2022-01-18T07:37:44.183461Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/c81585dc-d930-435e-9a39-057c99895a96/?format=api", "uuid": "c81585dc-d930-435e-9a39-057c99895a96", "name": "Hartweg gemaal, uitstroom", "code": "KGM-A-920_uit", "geometry": { "type": "Point", "coordinates": [ 4.898737830609337, 52.76083828086426, 0.0 ] }, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": { "id": 7333, "type": "pumpstation" }, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-11-05T10:24:42.744845Z", "last_modified": "2022-01-18T07:37:25.453217Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/648412cc-ae52-4de8-ba46-b0e7ab1e4054/?format=api", "uuid": "648412cc-ae52-4de8-ba46-b0e7ab1e4054", "name": "Geestmerambacht Warmenhuizen ge+in, boezem", "code": "KGM-Q-20288_boezem", "geometry": { "type": "Point", "coordinates": [ 4.732126305622276, 52.72274227339292, 0.0 ] }, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": { "id": 5716, "type": "pumpstation" }, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-11-05T10:24:45.719338Z", "last_modified": "2022-01-18T07:39:15.918618Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/66582489-c93d-444b-a38b-955da360daa2/?format=api", "uuid": "66582489-c93d-444b-a38b-955da360daa2", "name": "Koggeweg West, peil", "code": "KGM-JF-12_peil", "geometry": { "type": "Point", "coordinates": [ 4.955676673696569, 52.66372016823925, 0.0 ] }, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": { "id": 7316, "type": "pumpstation" }, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-11-05T10:24:59.183598Z", "last_modified": "2022-01-18T08:23:13.735846Z", "last_modified_by": "" }, { "url": "https://demo.lizard.net/api/v4/locations/9503eebe-1c87-478f-b9fc-6d859abc948e/?format=api", "uuid": "9503eebe-1c87-478f-b9fc-6d859abc948e", "name": "Laeg t gemaal, instroom", "code": "KGM-A-930_in", "geometry": { "type": "Point", "coordinates": [ 4.966899175076159, 52.71748477354515, 0.0 ] }, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api", "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb", "name": "Hoogheemraadschap Hollands Noorderkwartier" }, "object": { "id": 7358, "type": "pumpstation" }, "access_modifier": "Public", "extra_metadata": {}, "created": "2014-11-05T10:25:02.081553Z", "last_modified": "2022-01-18T08:08:39.178399Z", "last_modified_by": "" } ] }