Location List – 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/?format=api&page=5990

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

{
    "count": 59892,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&page=5989",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/01dfe876-8d7b-4532-b2f6-9fa192621b94/?format=api",
            "uuid": "01dfe876-8d7b-4532-b2f6-9fa192621b94",
            "name": "41EM009001",
            "code": "41EM009001",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    6.649901592020065,
                    51.95780564414218,
                    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": 126643,
                "type": "filter"
            },
            "access_modifier": "Public",
            "extra_metadata": {
                "bro": {
                    "id": 28959,
                    "glue": "geen",
                    "aquifer": null,
                    "tubeType": "standaardbuis",
                    "tubeNumber": 1,
                    "removalDate": null,
                    "dateModified": "2025-04-23T08:57:12Z",
                    "geoOhmCables": [],
                    "sockMaterial": "geen",
                    "tubeMaterial": "pvc",
                    "filterInRoute": true,
                    "temporal_data": [
                        {
                            "id": 84736,
                            "start": "2025-03-24T11:42:00Z",
                            "initial": true,
                            "broEvent": "None",
                            "tubeStatus": "gebruiksklaar",
                            "dateModified": "2025-04-16T08:55:31Z",
                            "referenceLevel": 29.37,
                            "instrumentDepth": null,
                            "tubeTopDiameter": 57.0,
                            "insertedPartLength": null,
                            "insertedPartPresent": false,
                            "insertedPartDiameter": null,
                            "insertedPartMaterial": null,
                            "tubeTopPositioningMethod": "RTKGPS20tot100cm"
                        }
                    ],
                    "filterTopDepth": 24.67,
                    "broid_gld_imbro": null,
                    "tubeBottomDepth": 23.67,
                    "broid_gld_imbroa": null,
                    "constructionDate": "2025-03-24T00:00:00Z",
                    "variableDiameter": "nee",
                    "filterBottomDepth": 23.67,
                    "sedimentSumpLength": null,
                    "sedimentSumpPresent": false,
                    "tubePackingMaterial": "bentonietFiltergrind",
                    "numberOfGeoOhmCables": 0,
                    "artesianWellCapPresent": false
                }
            },
            "created": "2025-04-23T08:57:13.730742Z",
            "last_modified": "2025-04-24T07:11:00.386847Z",
            "last_modified_by": "vitens_api"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/a86d6e3d-9655-435c-9e5d-39e8daea3606/?format=api",
            "uuid": "a86d6e3d-9655-435c-9e5d-39e8daea3606",
            "name": "GWS_1",
            "code": "AABBCC1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.683839188453384,
                    52.49446759721568,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/?format=api",
                "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb",
                "name": "Nelen & Schuurmans Consultancy"
            },
            "object": null,
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2025-04-28T13:25:15.087883Z",
            "last_modified": "2025-04-28T13:25:15.087847Z",
            "last_modified_by": "jelle.zitman@nelen-schuurmans.nl"
        }
    ]
}