Endpoint for interacting with locations.

Query parameters

created: Temporal filter on created. Supports various lookup types (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.

name: Text filter on name. Supports various lookup types (name__exact by default).

object_id: Number filter on the id attribute of an object. Supports various 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 various lookup types (organisation_code__exact by default).

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.

point: See dist.

uuid: Text filter on uuid. Supports a comma-separated list of (fragments of) UUIDs. UUIDs must be specified in their canonical form (with hyphens, that is). Case insensitive. Only supports uuid__icontains, the default.

extra_metadata__icontains: Text filter on extra_metadata field. Only icontains lookup is supported.

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

?name__icontains=gemaal

?object_type__model=sluice

?object_type__model=pumpstation&object_id=1

?ordering=name

?organisation__name=Noorderzijlvest

?organisation_code__startswith=WNS1400

?uuid=88f7-4c9f-8f28,15ea-4b7f-b2ed

?extra_metadata__icontains=foo
GET /api/v3/locations/
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 36599,
    "next": "https://demo.lizard.net/api/v3/locations/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v3/locations/6eb648bf-c5a4-4566-ac7a-1311ec69921c/",
            "id": 1,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "6eb648bf-c5a4-4566-ac7a-1311ec69921c",
            "name": "Stichtsch Ankeveensche Polder",
            "code": "3201",
            "geometry": null,
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": "",
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/faa84a55-cb8d-460c-a8b8-18d2b59da28c/",
            "id": 2,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "faa84a55-cb8d-460c-a8b8-18d2b59da28c",
            "name": "SAP verhard",
            "code": "3201_gw1",
            "geometry": null,
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/2945055d-7e04-4eb0-95e1-e05c6edd0274/",
            "id": 3,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "2945055d-7e04-4eb0-95e1-e05c6edd0274",
            "name": "SAP West",
            "code": "3201_gw2",
            "geometry": null,
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/619e1863-886f-4b1f-ad70-a975143c8332/",
            "id": 4,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "619e1863-886f-4b1f-ad70-a975143c8332",
            "name": "SAP Oost",
            "code": "3201_gw3",
            "geometry": null,
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/ed874824-d20f-4ba1-a332-f0c3f92738fa/",
            "id": 5,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "ed874824-d20f-4ba1-a332-f0c3f92738fa",
            "name": "Inlaat sGravelandseVaart",
            "code": "3201_PS1",
            "geometry": null,
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/5fa58247-5f14-44ea-b8a7-352c4e0a3832/",
            "id": 6,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "5fa58247-5f14-44ea-b8a7-352c4e0a3832",
            "name": "inlaat peilbeheer",
            "code": "3201_PS2",
            "geometry": null,
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/7661fb46-293b-44b1-baae-707b577ef744/",
            "id": 7,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "7661fb46-293b-44b1-baae-707b577ef744",
            "name": "uitlaat peilbeheer",
            "code": "3201_PS3",
            "geometry": null,
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/0e3933f0-1ce9-4d85-9708-1cd2018325e9/",
            "id": 8,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "0e3933f0-1ce9-4d85-9708-1cd2018325e9",
            "name": "A, boezem (hist 2013)",
            "code": "KGM-Q-29100_boezem",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.709151955388156,
                    52.74587223407126,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/dd0a3e59-dfa4-42ad-b74d-42cf4e2a9cb0/",
            "id": 9,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "dd0a3e59-dfa4-42ad-b74d-42cf4e2a9cb0",
            "name": "A, bovenpeil stuw",
            "code": "KGM-Q-29100_bovenS",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.709151955388156,
                    52.74587223407126,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        },
        {
            "url": "https://demo.lizard.net/api/v3/locations/77062565-935e-420b-a1f8-bcc401046f6f/",
            "id": 10,
            "node": {
                "url": "https://demo.lizard.net/api/v3/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/",
                "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
                "name": "Lizard",
                "description": "",
                "base_url": "",
                "master": true
            },
            "uuid": "77062565-935e-420b-a1f8-bcc401046f6f",
            "name": "A, instroom (hist 2013)",
            "code": "KGM-Q-29100_in",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.709151955388156,
                    52.74587223407126,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/",
                "name": "Hoogheemraadschap Hollands Noorderkwartier",
                "unique_id": "474afd212f2e4b4f82615142f1d67acb",
                "users_url": "https://demo.lizard.net/api/v3/organisations/474afd212f2e4b4f82615142f1d67acb/users/"
            },
            "access_modifier": "Public",
            "ddsc_show_on_map": false,
            "ddsc_icon_url": null,
            "extra_metadata": {}
        }
    ]
}