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/1d339fb1-a837-43bc-bda4-12cabe2d82e3/?format=api
{ "url": "https://zuiderzeeland.lizard.net/api/v4/locations/1d339fb1-a837-43bc-bda4-12cabe2d82e3/?format=api", "uuid": "1d339fb1-a837-43bc-bda4-12cabe2d82e3", "name": "32BP0209007", "code": "32BP0209007", "geometry": { "type": "Point", "coordinates": [ 5.396571666777019, 52.2302206227639, 0.0 ] }, "organisation": { "url": "https://zuiderzeeland.lizard.net/api/v4/organisations/e7d66583-43b2-4c90-b118-f2093798885a/?format=api", "uuid": "e7d66583-43b2-4c90-b118-f2093798885a", "name": "Vitens NV" }, "object": { "id": 58597, "type": "filter" }, "access_modifier": "Public", "extra_metadata": { "bro": { "id": 19606, "glue": "ongespecificeerd", "aquifer": null, "tubeType": "standaardbuis", "tubeNumber": 7, "removalDate": null, "dateModified": "2024-07-04T13:21:52Z", "geoOhmCables": [ { "electrodes": [ { "electrodeNumber": 13, "electrodeStatus": "gebruiksklaar", "electrodePosition": -200.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 12, "electrodeStatus": "gebruiksklaar", "electrodePosition": -195.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 11, "electrodeStatus": "gebruiksklaar", "electrodePosition": -190.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 10, "electrodeStatus": "gebruiksklaar", "electrodePosition": -185.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 9, "electrodeStatus": "gebruiksklaar", "electrodePosition": -180.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 8, "electrodeStatus": "gebruiksklaar", "electrodePosition": -170.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 7, "electrodeStatus": "gebruiksklaar", "electrodePosition": -160.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 6, "electrodeStatus": "gebruiksklaar", "electrodePosition": -150.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 5, "electrodeStatus": "gebruiksklaar", "electrodePosition": -140.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 4, "electrodeStatus": "gebruiksklaar", "electrodePosition": -130.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 3, "electrodeStatus": "gebruiksklaar", "electrodePosition": -120.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 2, "electrodeStatus": "gebruiksklaar", "electrodePosition": -110.78, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 1, "electrodeStatus": "gebruiksklaar", "electrodePosition": -100.78, "electrodePackingMaterial": "filtergrind" } ], "cableNumber": 1 } ], "sockMaterial": "geen", "tubeMaterial": "onbekend", "filterInRoute": true, "temporal_data": [ { "start": "2023-03-13T10:30:38Z", "initial": false, "broEvent": "21992", "tubeStatus": "gebruiksklaar", "dateModified": "2024-02-19T09:17:09Z", "referenceLevel": 0.96, "tubeTopDiameter": 32.0, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" } ], "filterTopDepth": -202.78, "broid_gld_imbro": null, "tubeBottomDepth": -204.78, "broid_gld_imbroa": null, "constructionDate": "1972-04-01T00:00:00Z", "variableDiameter": "nee", "filterBottomDepth": -204.78, "sedimentSumpLength": null, "sedimentSumpPresent": false, "tubePackingMaterial": "filtergrind", "numberOfGeoOhmCables": 1, "artesianWellCapPresent": false } }, "created": "2022-05-17T10:34:13.908622Z", "last_modified": "2024-07-08T16:19:10.263330Z", "last_modified_by": "vitens_api" }