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&page=2
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "paging": {
        "totalObjectCount": 59717,
        "prev": "https://demo.lizard.net/dd/api/v2/locations/?format=api",
        "next": "https://demo.lizard.net/dd/api/v2/locations/?format=api&page=3",
        "maxPageSize": 1000,
        "minPageSize": 2
    },
    "results": [
        {
            "id": "125926ae-2373-4ff4-9850-f4a0c75f9eac",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.966899175076159,
                    52.71748477354515,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/125926ae-2373-4ff4-9850-f4a0c75f9eac/?format=api",
                "locationCode": "KGM-A-930_uit",
                "locationName": "Laeg t 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": "881d8232-9829-45c3-b77a-7381ee165f0a",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.802622604578388,
                    53.05822111924456,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/881d8232-9829-45c3-b77a-7381ee165f0a/?format=api",
                "locationCode": "KGM-Q-29206_in",
                "locationName": "Mars (de), 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": ""
                }
            }
        },
        {
            "id": "fc327be0-ceb4-4afb-ad61-0e1b44375cae",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.802622604578388,
                    53.05822111924456,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/fc327be0-ceb4-4afb-ad61-0e1b44375cae/?format=api",
                "locationCode": "KGM-Q-29206_uit",
                "locationName": "Mars (de), 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": "3ad3fc8a-3701-428f-ab2e-8695aa4c6856",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.839674503435623,
                    52.58743536044665,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/3ad3fc8a-3701-428f-ab2e-8695aa4c6856/?format=api",
                "locationCode": "KGM-Q-20439_in",
                "locationName": "Menningweer, 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": ""
                }
            }
        },
        {
            "id": "9de2319e-9a43-4dfa-adb9-b2bfd405cb41",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.839674503435623,
                    52.58743536044665,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/9de2319e-9a43-4dfa-adb9-b2bfd405cb41/?format=api",
                "locationCode": "KGM-Q-20439_uit",
                "locationName": "Menningweer, 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": "2acaee61-6ca9-4c50-b332-8fe87894f1f2",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.929330056389002,
                    52.68895138797973,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/2acaee61-6ca9-4c50-b332-8fe87894f1f2/?format=api",
                "locationCode": "KGM-Q-31641",
                "locationName": "De Kaag",
                "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": "c33114c2-122b-4194-a4c6-3530d2438cbe",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.696311396596539,
                    52.77411661247911,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/c33114c2-122b-4194-a4c6-3530d2438cbe/?format=api",
                "locationCode": "KGM-Q-29112_boezem",
                "locationName": "NM-Zuid, 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": "41ef78f1-67bb-4265-8f54-9941cd064213",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.696311396596539,
                    52.77411661247911,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/41ef78f1-67bb-4265-8f54-9941cd064213/?format=api",
                "locationCode": "KGM-Q-29112_in",
                "locationName": "NM-Zuid, 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": ""
                }
            }
        },
        {
            "id": "7eac854d-89fa-41d2-a271-1fc4fb0452ed",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.995005711871558,
                    52.6025573050338,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/7eac854d-89fa-41d2-a271-1fc4fb0452ed/?format=api",
                "locationCode": "KGM-JG-350",
                "locationName": "Oudendijk 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": "b10a6791-76c1-4466-b3b7-c7d8a03d6af9",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.99323516659582,
                    52.60231300099481,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/b10a6791-76c1-4466-b3b7-c7d8a03d6af9/?format=api",
                "locationCode": "KGM-JG-349",
                "locationName": "Oudendijk 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": ""
                }
            }
        }
    ]
}