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/3a243797-f223-43be-aae3-05ada4298c8f/?format=api
{ "url": "https://zuiderzeeland.lizard.net/api/v4/locations/3a243797-f223-43be-aae3-05ada4298c8f/?format=api", "uuid": "3a243797-f223-43be-aae3-05ada4298c8f", "name": "BH1992-12005", "code": "BH1992-12005", "geometry": { "type": "Point", "coordinates": [ 6.16252704319012, 52.35846912200954, 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": 123636, "type": "filter" }, "access_modifier": "Public", "extra_metadata": { "bro": { "id": 28554, "glue": "ongespecificeerd", "aquifer": null, "tubeType": "standaardbuis", "tubeNumber": 5, "removalDate": null, "dateModified": "2024-04-22T13:40:55Z", "geoOhmCables": [ { "electrodes": [ { "electrodeNumber": 101, "electrodeStatus": "gebruiksklaar", "electrodePosition": -83.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 102, "electrodeStatus": "gebruiksklaar", "electrodePosition": -88.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 103, "electrodeStatus": "gebruiksklaar", "electrodePosition": -93.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 104, "electrodeStatus": "gebruiksklaar", "electrodePosition": -98.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 105, "electrodeStatus": "gebruiksklaar", "electrodePosition": -103.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 106, "electrodeStatus": "gebruiksklaar", "electrodePosition": -108.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 107, "electrodeStatus": "gebruiksklaar", "electrodePosition": -113.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 108, "electrodeStatus": "gebruiksklaar", "electrodePosition": -118.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 109, "electrodeStatus": "gebruiksklaar", "electrodePosition": -123.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 110, "electrodeStatus": "gebruiksklaar", "electrodePosition": -128.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 111, "electrodeStatus": "gebruiksklaar", "electrodePosition": -133.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 112, "electrodeStatus": "gebruiksklaar", "electrodePosition": -138.73, "electrodePackingMaterial": "filtergrind" }, { "electrodeNumber": 113, "electrodeStatus": "gebruiksklaar", "electrodePosition": -143.73, "electrodePackingMaterial": "filtergrind" } ], "cableNumber": 1 } ], "sockMaterial": "geen", "tubeMaterial": null, "filterInRoute": false, "temporal_data": [ { "start": "1992-11-26T11:00:00Z", "initial": true, "broEvent": null, "tubeStatus": "onbekend", "dateModified": "2024-03-22T12:01:58Z", "referenceLevel": null, "tubeTopDiameter": 36.0, "insertedPartLength": null, "insertedPartPresent": false, "insertedPartDiameter": null, "insertedPartMaterial": null, "tubeTopPositioningMethod": "waterpassing0tot2cm" } ], "filterTopDepth": -141.73, "broid_gld_imbro": null, "tubeBottomDepth": -143.73, "broid_gld_imbroa": null, "constructionDate": "1992-11-26T00:00:00Z", "variableDiameter": "nee", "filterBottomDepth": -143.73, "sedimentSumpLength": null, "sedimentSumpPresent": false, "tubePackingMaterial": "filtergrind", "numberOfGeoOhmCables": 1, "artesianWellCapPresent": false } }, "created": "2024-03-28T18:23:06.444445Z", "last_modified": "2024-07-05T19:22:38.658853Z", "last_modified_by": "vitens_api" }