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

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=4",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=2",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/f6c414a1-d4b4-4f5a-ae60-1d703f99b958/?format=api",
            "uuid": "f6c414a1-d4b4-4f5a-ae60-1d703f99b958",
            "name": "Inlaat grote Sloot zuid, Benedenpeil",
            "code": "KDU-Q-5717#MPN-AS-1324",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.731143558008715,
                    52.78409883833254,
                    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": 240738,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:22.251419Z",
            "last_modified": "2024-02-14T14:43:15.786409Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/10fe3b60-18d5-4040-82ed-a47bbe722089/?format=api",
            "uuid": "10fe3b60-18d5-4040-82ed-a47bbe722089",
            "name": "Inlaat grote Sloot zuid, Bovenpeil",
            "code": "KDU-Q-5717#MPN-AS-1323",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.731143558008715,
                    52.78409883833254,
                    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": 240737,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:22.367252Z",
            "last_modified": "2024-02-14T14:43:16.170225Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/7d0a0c07-9504-46c7-be32-5ea9f96056ed/?format=api",
            "uuid": "7d0a0c07-9504-46c7-be32-5ea9f96056ed",
            "name": "Inlaat Hensbroek, Benedenpeil",
            "code": "KDU-Q-13384#MPN-AS-720",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.869443417278794,
                    52.64687441800546,
                    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": 241882,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:23.202709Z",
            "last_modified": "2024-02-14T14:43:18.676787Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/423f3f3c-a790-40ee-a97e-704902a9df3d/?format=api",
            "uuid": "423f3f3c-a790-40ee-a97e-704902a9df3d",
            "name": "Inlaat Hoornse Vaart, Benedenpeil",
            "code": "KDU-Q-722#MPN-AS-1604",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.766798872914427,
                    52.64165062106643,
                    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": 240978,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:23.316627Z",
            "last_modified": "2024-02-14T14:43:19.077035Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/c32267af-0123-4446-b8df-bc3633ad9d7e/?format=api",
            "uuid": "c32267af-0123-4446-b8df-bc3633ad9d7e",
            "name": "Inlaat Hoornse Vaart, Bovenpeil",
            "code": "KDU-Q-722#MPN-AS-1603",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.766798872914427,
                    52.64165062106643,
                    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": 240977,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:23.435679Z",
            "last_modified": "2024-02-14T14:43:19.481811Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/b4f2f36f-5ac4-45f7-984a-36d234a5db0b/?format=api",
            "uuid": "b4f2f36f-5ac4-45f7-984a-36d234a5db0b",
            "name": "Inlaat Houtpolder / Meilag, Bovenpeil",
            "code": "KDU-Q-13304#MPN-AS-757",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.245271313295168,
                    52.68328345487757,
                    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": "2016-09-13T10:49:23.551529Z",
            "last_modified": "2022-01-18T07:39:04.368112Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/dedfcec0-928b-4bfe-aacc-321564271797/?format=api",
            "uuid": "dedfcec0-928b-4bfe-aacc-321564271797",
            "name": "Inlaat Houtpolder / Meilag, Benedenpeil 2",
            "code": "KDU-Q-13304#MPN-AS-756",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.245271313295168,
                    52.68328345487757,
                    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": "2016-09-13T10:49:23.663032Z",
            "last_modified": "2022-01-18T08:12:55.157472Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3f7481a9-d303-4455-90b0-ee701dddb0fc/?format=api",
            "uuid": "3f7481a9-d303-4455-90b0-ee701dddb0fc",
            "name": "Inlaat Houtpolder / Meilag, Benedenpeil 1",
            "code": "KDU-Q-13304#MPN-AS-755",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.245271313295168,
                    52.68328345487757,
                    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": 241914,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:23.777264Z",
            "last_modified": "2024-02-14T14:43:19.937744Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/5b5d5efd-5b1a-4f59-87f6-56b6febfbde5/?format=api",
            "uuid": "5b5d5efd-5b1a-4f59-87f6-56b6febfbde5",
            "name": "Inlaat Katwoude, Uitstroompeil",
            "code": "KDU-Q-28084#MPN-AS-54",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.052599408601407,
                    52.46903569245439,
                    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": 241713,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.141623Z",
            "last_modified": "2024-02-14T14:43:21.860963Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3e659702-4290-4a53-a678-64cf615543aa/?format=api",
            "uuid": "3e659702-4290-4a53-a678-64cf615543aa",
            "name": "Inlaat Katwoude, Benedenpeil",
            "code": "KDU-Q-28084#MPN-AS-55",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.052599408601407,
                    52.46903569245439,
                    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": 241724,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.258472Z",
            "last_modified": "2024-02-14T14:43:22.250206Z",
            "last_modified_by": "bkropf"
        }
    ]
}