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&name__startswith=Inlaat&page=19

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

{
    "count": 218,
    "next": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=20",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=18",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/cd92e678-8914-431f-bdad-e8067f163960/?format=api",
            "uuid": "cd92e678-8914-431f-bdad-e8067f163960",
            "name": "Inlaat Vier Noorder Koggen, Stand inlaat 2",
            "code": "KDU-Q-9876_schuif2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.117757900370498,
                    52.760185995425466,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22061,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.245264Z",
            "last_modified": "2022-01-18T07:38:13.729497Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/d93808f6-9a41-4872-aa6e-cfa578c9f5cf/?format=api",
            "uuid": "d93808f6-9a41-4872-aa6e-cfa578c9f5cf",
            "name": "Inlaat Oostzaan, Stand inlaat",
            "code": "KDU-Q-28114_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.908083263722662,
                    52.482898410031396,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22062,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.245539Z",
            "last_modified": "2022-01-18T07:39:32.480907Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/cafdccc2-b22e-4e00-8283-88d5b5fd0b30/?format=api",
            "uuid": "cafdccc2-b22e-4e00-8283-88d5b5fd0b30",
            "name": "Inlaat Oudesluis, Stand inlaat",
            "code": "KDU-Q-2025_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.812127204243386,
                    52.83242872277419,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22067,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.247037Z",
            "last_modified": "2022-01-18T07:37:18.391789Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/a6663264-566f-49c0-b8e3-3af94b2f5c7d/?format=api",
            "uuid": "a6663264-566f-49c0-b8e3-3af94b2f5c7d",
            "name": "Inlaat Houtpolder / Meilag, Stand inlaat",
            "code": "KDU-Q-13304_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.244967657591505,
                    52.68329587660334,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22058,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.247768Z",
            "last_modified": "2022-01-18T07:55:14.620790Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/212151a9-6c6e-4af9-8ef1-3828398da941/?format=api",
            "uuid": "212151a9-6c6e-4af9-8ef1-3828398da941",
            "name": "Inlaat A, Bedrijf inlaat",
            "code": "KDU-Q-3520_bedrijf_inlaat",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.697186862059199,
                    52.733706621123396,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22048,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.247966Z",
            "last_modified": "2022-01-18T07:37:40.229509Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/f35a709e-63c0-433b-8007-78f8224f3f30/?format=api",
            "uuid": "f35a709e-63c0-433b-8007-78f8224f3f30",
            "name": "Inlaat Katwoude, Bedrijf inlaat",
            "code": "KDU-Q-28084_bedrijf_inlaat",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.052749664994924,
                    52.4691737553594,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22060,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.248149Z",
            "last_modified": "2022-01-18T07:38:38.474371Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2291b75a-a74d-4cca-8ee6-2fb4fd246620/?format=api",
            "uuid": "2291b75a-a74d-4cca-8ee6-2fb4fd246620",
            "name": "Inlaat Katwoude, Aflaten naar polder",
            "code": "KDU-Q-28084_aflaten_naar_polder",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.052749664994924,
                    52.4691737553594,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22060,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.248340Z",
            "last_modified": "2022-01-18T07:38:13.603525Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/6493a5ee-a5d9-4e82-a721-0172fe9b821d/?format=api",
            "uuid": "6493a5ee-a5d9-4e82-a721-0172fe9b821d",
            "name": "Inlaat Rustenburg, Stand inlaat 2 (mNAP)",
            "code": "KDU-Q-34021_stand_inlaat_2_(mnap)",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.876434691468914,
                    52.634376429941476,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22089,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.251841Z",
            "last_modified": "2022-01-18T07:37:40.217301Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/aa72371f-0103-42ff-bec8-129a4b52f89f/?format=api",
            "uuid": "aa72371f-0103-42ff-bec8-129a4b52f89f",
            "name": "Inlaat Rustenburg, Stand inlaat 1 (mNAP)",
            "code": "KDU-Q-34021_stand_inlaat_1_(mnap)",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.876434691468914,
                    52.634376429941476,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22089,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.252066Z",
            "last_modified": "2022-01-18T08:17:21.009217Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/607a1271-3d87-46b1-b70e-06b18e9decf6/?format=api",
            "uuid": "607a1271-3d87-46b1-b70e-06b18e9decf6",
            "name": "Inlaat Wieringerrandweg, Stand inlaat",
            "code": "KDU-Q-7452_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.971511194678751,
                    52.890591599910366,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/474afd21-2f2e-4b4f-8261-5142f1d67acb/?format=api",
                "uuid": "474afd21-2f2e-4b4f-8261-5142f1d67acb",
                "name": "Hoogheemraadschap Hollands Noorderkwartier"
            },
            "object": {
                "id": 22029,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.252259Z",
            "last_modified": "2022-01-18T07:38:41.403366Z",
            "last_modified_by": ""
        }
    ]
}