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&page=5982

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

{
    "count": 59876,
    "next": "https://demo.lizard.net/api/v4/locations/?format=api&page=5983",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&page=5981",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/23c98ecc-b008-475b-b616-2e7f7cd5a4bd/?format=api",
            "uuid": "23c98ecc-b008-475b-b616-2e7f7cd5a4bd",
            "name": "Stuw Steenwijkertocht 1, kruinhoogte",
            "code": "ST4817-LT3",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.920069848616912,
                    52.71315941937352,
                    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": "2024-11-26T21:21:46.947194Z",
            "last_modified": "2024-11-27T06:00:05.382067Z",
            "last_modified_by": "sa_zuiderzeeland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/c2eb3db1-9b3f-440a-9e77-965bf1b0a587/?format=api",
            "uuid": "c2eb3db1-9b3f-440a-9e77-965bf1b0a587",
            "name": "Stuw Steenwijkertocht 2, waterhoogte HWZ",
            "code": "ST4891-LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.906888902172362,
                    52.71102489219721,
                    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": "2024-11-26T21:21:46.947262Z",
            "last_modified": "2024-11-27T06:00:05.423474Z",
            "last_modified_by": "sa_zuiderzeeland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/13da5437-8b3a-44c8-a86f-002ff607b449/?format=api",
            "uuid": "13da5437-8b3a-44c8-a86f-002ff607b449",
            "name": "Stuw Steenwijkertocht 2, waterhoogte LWZ",
            "code": "ST4891-LT2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.906859202185044,
                    52.711016034903196,
                    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": "2024-11-26T21:21:46.947318Z",
            "last_modified": "2024-11-27T06:00:05.487271Z",
            "last_modified_by": "sa_zuiderzeeland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3a92a6a0-718e-48ab-8710-30df038d2951/?format=api",
            "uuid": "3a92a6a0-718e-48ab-8710-30df038d2951",
            "name": "Stuw Steenwijkertocht 1, waterhoogte HWZ",
            "code": "ST4817-LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.920099443568179,
                    52.71315928681195,
                    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": "2024-11-26T21:21:46.947371Z",
            "last_modified": "2024-11-27T06:00:05.532404Z",
            "last_modified_by": "sa_zuiderzeeland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/49b0db53-66a1-456f-8d69-ea721f283c19/?format=api",
            "uuid": "49b0db53-66a1-456f-8d69-ea721f283c19",
            "name": "Stuw Steenwijkertocht 1, waterhoogte LWZ",
            "code": "ST4817-LT2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.920040144535867,
                    52.71315056537962,
                    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": "2024-11-26T21:21:46.947423Z",
            "last_modified": "2024-11-27T06:00:05.600956Z",
            "last_modified_by": "sa_zuiderzeeland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/0a3c06bd-0579-4ed5-8df4-340c6cb409c5/?format=api",
            "uuid": "0a3c06bd-0579-4ed5-8df4-340c6cb409c5",
            "name": "Rioolgemaal Beloop, hoofdmeter, inkoop",
            "code": "A04918030-HFD/Ap",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.52581543525884,
                    52.351384671207846,
                    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": "2024-12-02T14:12:21.361495Z",
            "last_modified": "2024-12-03T06:00:05.132174Z",
            "last_modified_by": "sa_zuiderzeeland"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/c1b0ea4a-ec47-4a58-ac4b-40fbae6b33d6/?format=api",
            "uuid": "c1b0ea4a-ec47-4a58-ac4b-40fbae6b33d6",
            "name": "Niveaumeter 1",
            "code": "131_1#LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.184499212651089,
                    52.38638920018982,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/83280e0e-2100-4a72-8f5f-78cc6abaedfb/?format=api",
                "uuid": "83280e0e-2100-4a72-8f5f-78cc6abaedfb",
                "name": "Almere"
            },
            "object": {
                "id": 31227,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {
                "tcn_tag_id": "2f323032-332d-3137-3636-2f56502f4c54-2f31"
            },
            "created": "2024-12-03T20:50:01.230872Z",
            "last_modified": "2024-12-23T10:09:07.362344Z",
            "last_modified_by": "taj.devries@nelen-schuurmans.nl"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/1e61862f-4a98-49d0-a672-07531876c3ad/?format=api",
            "uuid": "1e61862f-4a98-49d0-a672-07531876c3ad",
            "name": "Niveaumeter 1",
            "code": "224_1#LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.19058,
                    52.35379,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/83280e0e-2100-4a72-8f5f-78cc6abaedfb/?format=api",
                "uuid": "83280e0e-2100-4a72-8f5f-78cc6abaedfb",
                "name": "Almere"
            },
            "object": {
                "id": 31237,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {
                "tcn_tag_id": "2f323032-322d-3130-3133-2f56502f4c54-2f31"
            },
            "created": "2024-12-03T20:50:01.231054Z",
            "last_modified": "2024-12-23T10:08:50.396403Z",
            "last_modified_by": "taj.devries@nelen-schuurmans.nl"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/dace1715-3506-439a-91d4-614c3285c4bc/?format=api",
            "uuid": "dace1715-3506-439a-91d4-614c3285c4bc",
            "name": "Niveaumeter 1",
            "code": "228_1#LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.185378509366669,
                    52.369795246344395,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/83280e0e-2100-4a72-8f5f-78cc6abaedfb/?format=api",
                "uuid": "83280e0e-2100-4a72-8f5f-78cc6abaedfb",
                "name": "Almere"
            },
            "object": {
                "id": 31220,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {
                "tcn_tag_id": "2f323032-322d-3130-3130-2f56502f4c54-2f31"
            },
            "created": "2024-12-03T20:50:01.231079Z",
            "last_modified": "2024-12-23T10:08:48.262024Z",
            "last_modified_by": "taj.devries@nelen-schuurmans.nl"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/bbf0a601-51cc-499f-9eb1-b28e5d62ca07/?format=api",
            "uuid": "bbf0a601-51cc-499f-9eb1-b28e5d62ca07",
            "name": "Niveaumeter 2",
            "code": "228_1#LT2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.185378509366669,
                    52.369795246344395,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/83280e0e-2100-4a72-8f5f-78cc6abaedfb/?format=api",
                "uuid": "83280e0e-2100-4a72-8f5f-78cc6abaedfb",
                "name": "Almere"
            },
            "object": {
                "id": 31220,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {
                "tcn_tag_id": "2f323032-322d-3130-3130-2f56502f4c54-2f32"
            },
            "created": "2024-12-03T20:50:01.231339Z",
            "last_modified": "2024-12-23T10:08:47.874309Z",
            "last_modified_by": "taj.devries@nelen-schuurmans.nl"
        }
    ]
}