GET

Location List

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

{
    "count": 218,
    "next": null,
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=21",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/61e0071d-0cf8-4edb-8e9e-04c538ad5e57/?format=api",
            "uuid": "61e0071d-0cf8-4edb-8e9e-04c538ad5e57",
            "name": "Inlaat Drieban, lokstroompomp",
            "code": "KDU-A-4470_lokstroompomp",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.15098814165047,
                    52.62381108714329,
                    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": 23147,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2021-10-27T13:37:18.736829Z",
            "last_modified": "2022-01-18T07:38:39.488377Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/963b1976-c513-4670-80a7-43acb757a219/?format=api",
            "uuid": "963b1976-c513-4670-80a7-43acb757a219",
            "name": "Inlaat Immerhorn, lokstroompomp",
            "code": "KDU-A-957_lokstroompomp",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.283172050694745,
                    52.72198412393782,
                    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": 22057,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2021-10-27T13:37:18.736967Z",
            "last_modified": "2022-01-18T07:38:39.499848Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/eac6885f-509b-47a4-8bc7-1e1e6fee86dc/?format=api",
            "uuid": "eac6885f-509b-47a4-8bc7-1e1e6fee86dc",
            "name": "Inlaat Vier Noorder Koggen, lokstroompomp",
            "code": "KDU-Q-9876_lokstroompomp",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.117627526565454,
                    52.760161292400156,
                    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": "2021-10-27T13:37:18.737106Z",
            "last_modified": "2022-01-18T07:35:27.572833Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ca0a9665-529e-41da-b0d1-c1f2b995f03b/?format=api",
            "uuid": "ca0a9665-529e-41da-b0d1-c1f2b995f03b",
            "name": "Inlaatstuw 1, Stand stuw 2",
            "code": "KST-P-140303_stuw2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.765761497068011,
                    52.811210938998514,
                    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": 23168,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2021-10-27T13:37:52.213648Z",
            "last_modified": "2022-01-18T07:38:39.578197Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/fd589510-06cf-4c6d-891b-1a4b4719f152/?format=api",
            "uuid": "fd589510-06cf-4c6d-891b-1a4b4719f152",
            "name": "Inlaatstuw 1, Stand stuw 1",
            "code": "KST-P-140303_stuw1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.765761497068011,
                    52.811210938998514,
                    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": 23168,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2021-10-27T13:37:52.213785Z",
            "last_modified": "2022-01-18T07:38:43.515359Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/cb11db92-b8c1-4638-87bb-7891c3b8c936/?format=api",
            "uuid": "cb11db92-b8c1-4638-87bb-7891c3b8c936",
            "name": "Inlaatwerk Blokzijl, totaal debiet",
            "code": "IW4530-QTOT",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.956980189565081,
                    52.72481532633959,
                    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": null,
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2023-07-05T09:01:30.512797Z",
            "last_modified": "2023-07-06T05:00:04.288860Z",
            "last_modified_by": "karl.schutt"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/22a0a79e-6ae7-4121-8bbe-67d1b96e8f49/?format=api",
            "uuid": "22a0a79e-6ae7-4121-8bbe-67d1b96e8f49",
            "name": "Inlaatwerk Lemmer - Rutten, totaal debiet",
            "code": "IW4500-QTOT",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.704669660039031,
                    52.83405559728629,
                    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": null,
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2023-07-05T09:01:30.512963Z",
            "last_modified": "2023-07-06T05:00:04.386401Z",
            "last_modified_by": "karl.schutt"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/e6f6b2a0-ccc4-47a7-b2ef-81218495e505/?format=api",
            "uuid": "e6f6b2a0-ccc4-47a7-b2ef-81218495e505",
            "name": "Inlaatwerk Colijn, debiet",
            "code": "IW4570-INLAATDEB",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.758003888279994,
                    52.57940257448379,
                    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": 229573,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2023-07-27T14:01:36.418419Z",
            "last_modified": "2023-07-28T05:00:03.304431Z",
            "last_modified_by": "karl.schutt"
        }
    ]
}