Endpoint for interacting with locations.

Query parameters

created: Temporal filter on created. Supports created__icontains, created__iexact, created__gte, created__gt, created__lt, created__lte, created__startswith. (created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

dist: Spatial filter on geometry. Also requires a point in (lon, lat) format. Distances, in meters, are internally converted to degrees. This conversion is approximate (and worse for high latitudes).

geom_isnull: Boolean filter on geometry.

geom_within: Spatial filter on geometry. Supports WKT, HEXEWKB, and GeoJSON.

in_bbox: Spatial filter on geometry. The bounding box format is: min Lat, min Lon, max Lat, max Lon. Includes locations that overlap the bounding box.

locationName: Text filter on name. Supports locationName__icontains, locationName__startswith lookup types(name__exact by default).

locationCode: Text filter on code. Supports locationCode__icontains, locationCode__startswith lookup types (locationCode__exact by default).

object_id: Number filter on the id attribute of an object. Supports object_id__icontains, object_id__startswith lookup types (object_id__exact by default). To be used in combination with object_type.

object_type: Related filter on object. See below for an example on how to filter on assets like sluices, pump stations, etc.

ordering: Offers basic ordering functionality on the name attribute of locations. Orderings may be reversed by prefixing the attribute with '-'.

organisation: Related filter on organisation. See the organisations endpoint.

organisation_code (or just code for short): Text filter on code. Supports organisation_code__icontains, organisation_code__exact, organisation_code__startswith lookup types (organisation_code__exact by default).

page: To prevent system overloads, list-view results are paginated. This parameter specifies which page to return.

pageSize: The maximum number of results to return in list-view. The default is 10.

point: See dist.

locationId: Text filter on uuid. Supports a comma-separated list of (fragments of) UUIDs. Supports locationId__icontains and locationId__iexact as default.

Examples

?created__gte=2017-01-01T00:00:00Z

?dist=1000&point=4.87,52.73

?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]]]}

?in_bbox=4.86,52.73,4.98,52.79

?locationName__icontains=gemaal

?object_type__model=sluice

?object_type__model=pumpstation&object_id=1

?ordering=name

?organisation__name=Noorderzijlvest

?organisation_code__startswith=WNS1400

?locationId__icontains=67035326-c5e3-41d2-ba7a-0bd4b8626b29
GET /dd/api/v2/locations/?format=api
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "paging": {
        "totalObjectCount": 59715,
        "prev": null,
        "next": "https://demo.lizard.net/dd/api/v2/locations/?format=api&page=2",
        "maxPageSize": 1000,
        "minPageSize": 2
    },
    "results": [
        {
            "id": "faa84a55-cb8d-460c-a8b8-18d2b59da28c",
            "type": "Feature",
            "geometry": null,
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/faa84a55-cb8d-460c-a8b8-18d2b59da28c/?format=api",
                "locationCode": "3201_gw1",
                "locationName": "SAP verhard",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "619e1863-886f-4b1f-ad70-a975143c8332",
            "type": "Feature",
            "geometry": null,
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/619e1863-886f-4b1f-ad70-a975143c8332/?format=api",
                "locationCode": "3201_gw3",
                "locationName": "SAP Oost",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "ed874824-d20f-4ba1-a332-f0c3f92738fa",
            "type": "Feature",
            "geometry": null,
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/ed874824-d20f-4ba1-a332-f0c3f92738fa/?format=api",
                "locationCode": "3201_PS1",
                "locationName": "Inlaat sGravelandseVaart",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "5fa58247-5f14-44ea-b8a7-352c4e0a3832",
            "type": "Feature",
            "geometry": null,
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/5fa58247-5f14-44ea-b8a7-352c4e0a3832/?format=api",
                "locationCode": "3201_PS2",
                "locationName": "inlaat peilbeheer",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "7661fb46-293b-44b1-baae-707b577ef744",
            "type": "Feature",
            "geometry": null,
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/7661fb46-293b-44b1-baae-707b577ef744/?format=api",
                "locationCode": "3201_PS3",
                "locationName": "uitlaat peilbeheer",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "ea1084be-eb6e-4800-95b7-25f2cdbfe94f",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.124763259163939,
                    52.65208344541993,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/ea1084be-eb6e-4800-95b7-25f2cdbfe94f/?format=api",
                "locationCode": "KGM-Q-31595",
                "locationName": "Blokdijk West",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "c81585dc-d930-435e-9a39-057c99895a96",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.898737830609337,
                    52.76083828086426,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/c81585dc-d930-435e-9a39-057c99895a96/?format=api",
                "locationCode": "KGM-A-920_uit",
                "locationName": "Hartweg gemaal, uitstroom",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "648412cc-ae52-4de8-ba46-b0e7ab1e4054",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.732126305622276,
                    52.72274227339292,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/648412cc-ae52-4de8-ba46-b0e7ab1e4054/?format=api",
                "locationCode": "KGM-Q-20288_boezem",
                "locationName": "Geestmerambacht Warmenhuizen ge+in, boezem",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "66582489-c93d-444b-a38b-955da360daa2",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.955676673696569,
                    52.66372016823925,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/66582489-c93d-444b-a38b-955da360daa2/?format=api",
                "locationCode": "KGM-JF-12_peil",
                "locationName": "Koggeweg West, peil",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        },
        {
            "id": "9503eebe-1c87-478f-b9fc-6d859abc948e",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.966899175076159,
                    52.71748477354515,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/9503eebe-1c87-478f-b9fc-6d859abc948e/?format=api",
                "locationCode": "KGM-A-930_in",
                "locationName": "Laeg t gemaal, instroom",
                "node": {
                    "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
                    "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                    "name": "Lizard",
                    "description": "",
                    "baseUrl": ""
                }
            }
        }
    ]
}