Location Instance – Django REST framework

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/f0419ab4-b8a2-4331-af25-67a7a09ffea3/?format=api

HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "url": "https://demo.lizard.net/api/v4/locations/f0419ab4-b8a2-4331-af25-67a7a09ffea3/?format=api",
    "uuid": "f0419ab4-b8a2-4331-af25-67a7a09ffea3",
    "name": "28A0538001",
    "code": "28A0538001",
    "geometry": {
        "type": "Point",
        "coordinates": [
            6.429489799904701,
            52.47849462776927,
            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": 44620,
        "type": "filter"
    },
    "access_modifier": "Public",
    "extra_metadata": {
        "bro": {
            "id": 361,
            "glue": "ongespecificeerd",
            "aquifer": null,
            "tubeType": "standaardbuis",
            "tubeNumber": 1,
            "removalDate": null,
            "dateModified": "2024-09-11T07:06:39Z",
            "geoOhmCables": [],
            "sockMaterial": "geen",
            "tubeMaterial": "onbekend",
            "filterInRoute": true,
            "temporal_data": [
                {
                    "start": "2007-04-30T22:00:00Z",
                    "initial": true,
                    "broEvent": null,
                    "tubeStatus": "onbekend",
                    "dateModified": "2023-01-06T02:17:30Z",
                    "referenceLevel": 7.54,
                    "tubeTopDiameter": null,
                    "insertedPartLength": null,
                    "insertedPartPresent": false,
                    "insertedPartDiameter": null,
                    "insertedPartMaterial": null,
                    "tubeTopPositioningMethod": "waterpassing0tot2cm"
                },
                {
                    "start": "2007-11-27T11:00:00Z",
                    "initial": false,
                    "broEvent": "43840",
                    "tubeStatus": "onbekend",
                    "dateModified": "2022-12-06T10:57:17Z",
                    "referenceLevel": 7.54,
                    "tubeTopDiameter": null,
                    "insertedPartLength": null,
                    "insertedPartPresent": false,
                    "insertedPartDiameter": null,
                    "insertedPartMaterial": null,
                    "tubeTopPositioningMethod": "waterpassing0tot2cm"
                },
                {
                    "start": "2017-06-07T08:39:00Z",
                    "initial": false,
                    "broEvent": "43841",
                    "tubeStatus": "onbekend",
                    "dateModified": "2024-09-11T07:06:39Z",
                    "referenceLevel": 7.54,
                    "tubeTopDiameter": null,
                    "insertedPartLength": null,
                    "insertedPartPresent": false,
                    "insertedPartDiameter": null,
                    "insertedPartMaterial": null,
                    "tubeTopPositioningMethod": "waterpassing0tot2cm"
                },
                {
                    "start": "2021-05-10T09:55:00Z",
                    "initial": false,
                    "broEvent": "43842",
                    "tubeStatus": "onbekend",
                    "dateModified": "2024-09-11T07:05:43Z",
                    "referenceLevel": 7.54,
                    "tubeTopDiameter": null,
                    "insertedPartLength": null,
                    "insertedPartPresent": false,
                    "insertedPartDiameter": null,
                    "insertedPartMaterial": null,
                    "tubeTopPositioningMethod": "waterpassing0tot2cm"
                },
                {
                    "start": "2023-01-24T05:00:00Z",
                    "initial": false,
                    "broEvent": "21537",
                    "tubeStatus": "onbekend",
                    "dateModified": "2024-08-20T05:34:50Z",
                    "referenceLevel": 7.54,
                    "tubeTopDiameter": null,
                    "insertedPartLength": null,
                    "insertedPartPresent": false,
                    "insertedPartDiameter": null,
                    "insertedPartMaterial": null,
                    "tubeTopPositioningMethod": "waterpassing0tot2cm"
                },
                {
                    "start": "2024-03-26T23:40:00Z",
                    "initial": false,
                    "broEvent": "60342",
                    "tubeStatus": "onbekend",
                    "dateModified": "2024-08-20T05:34:50Z",
                    "referenceLevel": 7.53,
                    "tubeTopDiameter": null,
                    "insertedPartLength": null,
                    "insertedPartPresent": false,
                    "insertedPartDiameter": null,
                    "insertedPartMaterial": null,
                    "tubeTopPositioningMethod": "waterpassing0tot2cm"
                }
            ],
            "filterTopDepth": -0.46,
            "broid_gld_imbro": null,
            "tubeBottomDepth": -1.46,
            "broid_gld_imbroa": null,
            "constructionDate": "2007-05-01T00:00:00Z",
            "variableDiameter": "nee",
            "filterBottomDepth": -1.46,
            "sedimentSumpLength": null,
            "sedimentSumpPresent": false,
            "tubePackingMaterial": "filtergrind",
            "numberOfGeoOhmCables": 0,
            "artesianWellCapPresent": false
        }
    },
    "created": "2016-02-10T20:03:16.914444Z",
    "last_modified": "2024-09-26T14:36:04.124385Z",
    "last_modified_by": "vitens_api"
}