Location Instance
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/d7f7fba6-6b6b-44d3-8f18-4e3bdb3c8df1/?format=api
{ "url": "https://demo.lizard.net/api/v4/locations/d7f7fba6-6b6b-44d3-8f18-4e3bdb3c8df1/?format=api", "uuid": "d7f7fba6-6b6b-44d3-8f18-4e3bdb3c8df1", "name": "28HP0447001", "code": "28HP0447001", "geometry": { "type": "Point", "coordinates": [ 6.792577870560716, 52.28323037113646, 0.0 ] }, "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/e7d66583-43b2-4c90-b118-f2093798885a/?format=api", "uuid": "e7d66583-43b2-4c90-b118-f2093798885a", "name": "Vitens NV" }, "object": { "id": 45847, "type": "filter" }, "access_modifier": "Public", "extra_metadata": { "bro": { "id": 1969, "glue": "ongespecificeerd", "aquifer": null, "tubeType": "standaardbuis", "tubeNumber": 1, "removalDate": null, "dateModified": "2024-08-21T06:35:12Z", "geoOhmCables": [], "sockMaterial": "geen", "tubeMaterial": "onbekend", "filterInRoute": true, "temporal_data": [ { "start": "1983-04-07T22:00:00Z", "initial": true, "broEvent": null, "tubeStatus": "onbekend", "dateModified": "2023-01-06T02:31:32Z", "referenceLevel": 15.95, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "1988-01-28T09:00:00Z", "initial": false, "broEvent": "46725", "tubeStatus": "onbekend", "dateModified": "2022-12-06T11:00:17Z", "referenceLevel": 15.92, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2005-10-13T09:00:00Z", "initial": false, "broEvent": "46726", "tubeStatus": "onbekend", "dateModified": "2022-12-06T11:00:18Z", "referenceLevel": 15.92, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2008-01-17T10:00:00Z", "initial": false, "broEvent": "46727", "tubeStatus": "onbekend", "dateModified": "2022-12-06T11:00:18Z", "referenceLevel": 15.93, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2019-07-18T08:20:00Z", "initial": false, "broEvent": "46728", "tubeStatus": "onbekend", "dateModified": "2022-12-06T11:00:18Z", "referenceLevel": 15.93, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2020-11-17T09:35:00Z", "initial": false, "broEvent": "46729", "tubeStatus": "onbekend", "dateModified": "2024-06-14T06:48:57Z", "referenceLevel": 15.93, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2022-09-27T23:40:00Z", "initial": false, "broEvent": "59904", "tubeStatus": "onbekend", "dateModified": "2024-06-14T06:48:57Z", "referenceLevel": 15.89, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2023-07-05T07:08:00Z", "initial": false, "broEvent": "23405", "tubeStatus": "onbekend", "dateModified": "2024-08-21T06:35:13Z", "referenceLevel": 16.49, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2024-03-20T08:08:19Z", "initial": false, "broEvent": "59133", "tubeStatus": "onbekend", "dateModified": "2024-08-21T06:35:13Z", "referenceLevel": 16.49, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" }, { "start": "2024-03-20T09:30:00Z", "initial": false, "broEvent": "59117", "tubeStatus": "onbekend", "dateModified": "2024-08-21T05:06:15Z", "referenceLevel": 16.49, "tubeTopDiameter": null, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" } ], "filterTopDepth": 14.53, "broid_gld_imbro": "GLD000000031589", "tubeBottomDepth": 13.53, "broid_gld_imbroa": "GLD000000031606", "constructionDate": "1983-04-08T00:00:00Z", "variableDiameter": "nee", "filterBottomDepth": 13.53, "sedimentSumpLength": null, "sedimentSumpPresent": false, "tubePackingMaterial": "filtergrind", "numberOfGeoOhmCables": 0, "artesianWellCapPresent": false } }, "created": "2016-02-10T19:04:36.351428Z", "last_modified": "2024-08-27T13:40:41.268521Z", "last_modified_by": "vitens_api" }