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

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

{
    "count": 289,
    "next": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=29",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=27",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/2e6b9e9b-c65f-4448-9eed-65efadceb140/?format=api",
            "uuid": "2e6b9e9b-c65f-4448-9eed-65efadceb140",
            "name": "Inlaatschuif berging Diepgatweg, Stand schuif Noor",
            "code": "KST-Q-19380_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.803563151965908,
                    52.71822056323833,
                    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": 22434,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:18:20.870454Z",
            "last_modified": "2022-01-18T08:22:02.612449Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/a2fdc1db-3753-422b-a30d-053f996baa62/?format=api",
            "uuid": "a2fdc1db-3753-422b-a30d-053f996baa62",
            "name": "Inlaat, Stand aflaat",
            "code": "KST-OH-510_stand_aflaat",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.801670732675665,
                    52.82742786211709,
                    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": 22791,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:18:20.952029Z",
            "last_modified": "2022-01-18T07:38:38.444705Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/fa2354fa-14b6-47f9-9049-ede473598e84/?format=api",
            "uuid": "fa2354fa-14b6-47f9-9049-ede473598e84",
            "name": "Inlaat/uitlaat schuif Rijweg, Schuif benedenpeil",
            "code": "KDU-Q-12472_schuif_benedenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.085229789846086,
                    52.685690629754006,
                    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": 22056,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-18T05:49:38.391199Z",
            "last_modified": "2022-01-18T07:35:35.084362Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/760c425c-9554-4206-8a71-1c5931797732/?format=api",
            "uuid": "760c425c-9554-4206-8a71-1c5931797732",
            "name": "Inlaat/uitlaat schuif Rijweg, Schuif bovenpeil",
            "code": "KDU-Q-12472_schuif_bovenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.085229789846086,
                    52.685690629754006,
                    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": 22056,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-18T05:49:38.391463Z",
            "last_modified": "2022-01-18T07:38:27.780982Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/8ae41b26-6694-4fbe-971e-d9bdcda502f7/?format=api",
            "uuid": "8ae41b26-6694-4fbe-971e-d9bdcda502f7",
            "name": "Inlaatwerk Lemmer/Rutten, klepstand Ruttenzijde",
            "code": "IW4500-LT5",
            "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-08-14T10:37:52.632036Z",
            "last_modified": "2022-01-18T03:52:07.954358Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/b17975bb-ba36-4b82-947c-22de39562ad0/?format=api",
            "uuid": "b17975bb-ba36-4b82-947c-22de39562ad0",
            "name": "Inlaat Spanbroek, Schuif benedenpeil",
            "code": "KDU-N-1000_schuif_benedenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.942377838022352,
                    52.69818731883943,
                    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": 22034,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-09-11T05:37:17.249505Z",
            "last_modified": "2022-01-18T07:37:21.176541Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/acd8b68d-216e-45bf-a713-6465a71eda49/?format=api",
            "uuid": "acd8b68d-216e-45bf-a713-6465a71eda49",
            "name": "Inlaat Spanbroek, Schuif bovenpeil",
            "code": "KDU-N-1000_schuif_bovenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.942377838022352,
                    52.69818731883943,
                    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": 22034,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-09-11T05:37:17.249859Z",
            "last_modified": "2022-01-18T07:37:28.927426Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/7dbe3cda-ff01-466f-8d73-252af06f6cb4/?format=api",
            "uuid": "7dbe3cda-ff01-466f-8d73-252af06f6cb4",
            "name": "Inlaatwerk Kuinre, debiet",
            "code": "IW4560-Q",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.842423726906976,
                    52.7848178081258,
                    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": "2021-07-27T14:21:04.306383Z",
            "last_modified": "2022-01-18T03:45:11.228232Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/41bda2bb-4195-4866-b1f9-063f689ff3f0/?format=api",
            "uuid": "41bda2bb-4195-4866-b1f9-063f689ff3f0",
            "name": "Inlaatwerk Ramspol, debiet",
            "code": "IW4540-FT",
            "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": "2021-07-27T14:22:00.340310Z",
            "last_modified": "2022-01-18T03:43:11.129154Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/cec6b367-b33d-4e26-9ab4-747849fee5e7/?format=api",
            "uuid": "cec6b367-b33d-4e26-9ab4-747849fee5e7",
            "name": "Inlaat Drieban, Inlaat 1 stand (Noord)",
            "code": "KDU-A-4470_schuif1",
            "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-09-21T04:35:18.103426Z",
            "last_modified": "2022-01-18T07:37:45.594216Z",
            "last_modified_by": ""
        }
    ]
}