Location List – Django REST framework

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=3

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&page=2",
        "next": "https://demo.lizard.net/dd/api/v2/locations/?format=api&page=4",
        "maxPageSize": 1000,
        "minPageSize": 2
    },
    "results": [
        {
            "id": "13bc925b-7664-4636-bee7-af3814c80e36",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.73544361058399,
                    52.865077545173136,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/13bc925b-7664-4636-bee7-af3814c80e36/?format=api",
                "locationCode": "KGM-A-369_in",
                "locationName": "Scheidingsvliet, 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": "6329a784-2990-4235-bd29-36a56a7100a8",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.012007460121332,
                    52.61966495341463,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/6329a784-2990-4235-bd29-36a56a7100a8/?format=api",
                "locationCode": "KGM-P-311000",
                "locationName": "Spoorvijver",
                "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": "0236616d-00fc-4629-85df-f598522e2aef",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.147082740172539,
                    52.73934627069197,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/0236616d-00fc-4629-85df-f598522e2aef/?format=api",
                "locationCode": "KGM-Q-31673_in(-2,20)",
                "locationName": "Vier Noorder Koggen gemaal, instroom (-2,20)",
                "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": "66ad3c40-c66f-4bff-a558-550c25211706",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.147082740172539,
                    52.73934627069197,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/66ad3c40-c66f-4bff-a558-550c25211706/?format=api",
                "locationCode": "KGM-Q-31673_in(-3,70)",
                "locationName": "Vier Noorder Koggen gemaal, instroom (-3,70)",
                "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": "8fdeb240-6ef1-4d93-8ec3-76371b9829fa",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.814464208627817,
                    52.87180428883091,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/8fdeb240-6ef1-4d93-8ec3-76371b9829fa/?format=api",
                "locationCode": "KGM-Q-25397",
                "locationName": "Volkstuinen Anna Paulowna",
                "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": "e409b32f-74b3-4699-908e-4128a02fb758",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.745329635155759,
                    52.84714859803786,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/e409b32f-74b3-4699-908e-4128a02fb758/?format=api",
                "locationCode": "KGM-Q-29208_in",
                "locationName": "Zwaan, 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": "f6782f59-62ae-4976-8a2f-006fb705b2a6",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.752858898491404,
                    52.79952275869057,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/f6782f59-62ae-4976-8a2f-006fb705b2a6/?format=api",
                "locationCode": "KDU-Q-6957",
                "locationName": "H-on",
                "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": "b10da8b3-df84-41c7-855d-d4dcf69767b6",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.899738188481025,
                    52.4334979012271,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/b10da8b3-df84-41c7-855d-d4dcf69767b6/?format=api",
                "locationCode": "KSL-Q-8161",
                "locationName": "Luijendijk",
                "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": "8d51324f-86ab-4d3d-a15d-8ab91fc41802",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.675045921587389,
                    52.54242436016523,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/8d51324f-86ab-4d3d-a15d-8ab91fc41802/?format=api",
                "locationCode": "982",
                "locationName": "Busch en Dam",
                "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": "4d3a32d0-1ddc-43ba-a1b1-2a9fd3b46a95",
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.66760726885984,
                    52.623794480774976,
                    0.0
                ]
            },
            "properties": {
                "url": "https://demo.lizard.net/dd/api/v2/locations/4d3a32d0-1ddc-43ba-a1b1-2a9fd3b46a95/?format=api",
                "locationCode": "963",
                "locationName": "Egmond",
                "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": ""
                }
            }
        }
    ]
}