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

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=14",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=12",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/2f6dcff0-56f6-4f5b-b052-671c6ec3e0cc/?format=api",
            "uuid": "2f6dcff0-56f6-4f5b-b052-671c6ec3e0cc",
            "name": "Inlaatwerk Blokzijl, debiet (schuif 1)",
            "code": "IW4530-FT",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.956963642376497,
                    52.72476067893209,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23055,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-09T09:06:45.973546Z",
            "last_modified": "2022-01-18T03:28:20.568020Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/18aa6ae2-b7ec-4684-9224-ba5fcc3b8d62/?format=api",
            "uuid": "18aa6ae2-b7ec-4684-9224-ba5fcc3b8d62",
            "name": "Inlaat Kanaalweg, debiet",
            "code": "IW4535-FT",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.951099388641039,
                    52.71189220229095,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23053,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.989335Z",
            "last_modified": "2022-01-18T03:22:00.429815Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/c1b84f4a-c14f-4e45-ac59-c0973230ac9f/?format=api",
            "uuid": "c1b84f4a-c14f-4e45-ac59-c0973230ac9f",
            "name": "Inlaatwerk Blokzijl, schuifstand 2",
            "code": "IW4530-LT4",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.956963642376497,
                    52.72476067893209,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23055,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.989611Z",
            "last_modified": "2022-01-18T03:33:26.146700Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/077cf507-baa1-487a-9258-8855d14c9a09/?format=api",
            "uuid": "077cf507-baa1-487a-9258-8855d14c9a09",
            "name": "Inlaatwerk Blokzijl, schuifstand 1",
            "code": "IW4530-LT3",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.956963642376497,
                    52.72476067893209,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23055,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.989794Z",
            "last_modified": "2022-01-18T03:24:56.076382Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/db5838de-efe6-42d9-b367-17528d637f24/?format=api",
            "uuid": "db5838de-efe6-42d9-b367-17528d637f24",
            "name": "Inlaat Kuinre, Schuifstand",
            "code": "IW4560-R",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.842411025586023,
                    52.7847651938887,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23051,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.989956Z",
            "last_modified": "2022-01-18T03:32:40.199390Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/6efd852c-535d-4fb7-bfc5-94dde9afbc1e/?format=api",
            "uuid": "6efd852c-535d-4fb7-bfc5-94dde9afbc1e",
            "name": "Inlaatwerk Ramspol, schuifstand",
            "code": "IW4540-LT3",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.851221742661465,
                    52.61600886236202,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23054,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.990103Z",
            "last_modified": "2022-01-18T03:34:14.446913Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/7a7a66b0-a2f6-40aa-bd72-430fdcee3d2b/?format=api",
            "uuid": "7a7a66b0-a2f6-40aa-bd72-430fdcee3d2b",
            "name": "Inlaatwerk Lemmer/Rutten, Ruttenzijde debiet",
            "code": "IW4500-FT5",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.704670005427188,
                    52.83406055485742,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23057,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.990246Z",
            "last_modified": "2022-01-18T03:45:53.668702Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/69d627b7-a04a-413f-a5df-a7e57e6b317a/?format=api",
            "uuid": "69d627b7-a04a-413f-a5df-a7e57e6b317a",
            "name": "Inlaat Lemsterhop, debiet",
            "code": "IW4520-FT",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.721279470801213,
                    52.84448768686686,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23052,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.990384Z",
            "last_modified": "2022-01-18T03:24:11.935687Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/56dc4e1b-013e-4321-a916-a6eba94bf5bf/?format=api",
            "uuid": "56dc4e1b-013e-4321-a916-a6eba94bf5bf",
            "name": "Inlaatwerk Lemmer/Rutten, Lemmerzijde, debiet",
            "code": "IW4500-FT3",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.70468320206963,
                    52.83394679379565,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23057,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.990522Z",
            "last_modified": "2022-01-18T03:48:33.652604Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/812cf75b-e021-4f5a-9ea3-dfcfc6cff0a2/?format=api",
            "uuid": "812cf75b-e021-4f5a-9ea3-dfcfc6cff0a2",
            "name": "Inlaatwerk Waterloopbos, schuifstand",
            "code": "IW4545-LT3",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.93057676198378,
                    52.67377927249751,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23056,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-23T16:06:39.990659Z",
            "last_modified": "2022-01-18T03:47:29.444989Z",
            "last_modified_by": "emile.debadts"
        }
    ]
}