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": 218,
    "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/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"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/322efa97-5772-4f21-bbf0-7be6f20d7a1c/?format=api",
            "uuid": "322efa97-5772-4f21-bbf0-7be6f20d7a1c",
            "name": "Inlaat Kolhorn, Benedenpeil",
            "code": "KDU-Q-1958#MPN-AS-1898",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.903734556576576,
                    52.79276797017617,
                    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": 22043,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.380409Z",
            "last_modified": "2022-01-18T07:44:02.575569Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/914bd1cc-b915-4627-a203-22f489bda284/?format=api",
            "uuid": "914bd1cc-b915-4627-a203-22f489bda284",
            "name": "Inlaat Kolhorn, Bovenpeil",
            "code": "KDU-Q-1958#MPN-AS-1314",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.903734556576576,
                    52.79276797017617,
                    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": 242361,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.497853Z",
            "last_modified": "2024-02-14T14:43:22.673167Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/f6c2a178-edb5-4a18-8e4e-628b3134859f/?format=api",
            "uuid": "f6c2a178-edb5-4a18-8e4e-628b3134859f",
            "name": "Inlaat Kolping Boys, Bovenpeil",
            "code": "KDU-Q-723#MPN-AS-1605",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.777515167300978,
                    52.63986869600731,
                    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": 240979,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.612201Z",
            "last_modified": "2024-02-14T14:43:23.058184Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ae6b15ce-1b6f-4c3a-9627-44541435a30b/?format=api",
            "uuid": "ae6b15ce-1b6f-4c3a-9627-44541435a30b",
            "name": "Inlaat Krabbedam, Peilmeting",
            "code": "KDU-Q-718#MPN-AS-873",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.703560456818736,
                    52.73246928473432,
                    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": 242032,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.732178Z",
            "last_modified": "2024-02-14T14:43:23.510230Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/d3cb90db-7d6e-4336-922e-62a62904420c/?format=api",
            "uuid": "d3cb90db-7d6e-4336-922e-62a62904420c",
            "name": "Inlaat Krabbedam, Benedenpeil 2",
            "code": "KDU-Q-718#MPN-AS-875",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.703560456818736,
                    52.73246928473432,
                    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": 242034,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.850837Z",
            "last_modified": "2024-02-14T14:43:23.980944Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/97ad0c91-4a45-4286-b80f-46f5c087950f/?format=api",
            "uuid": "97ad0c91-4a45-4286-b80f-46f5c087950f",
            "name": "Inlaat Krabbedam, Benedenpeil 1",
            "code": "KDU-Q-718#MPN-AS-874",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.703560456818736,
                    52.73246928473432,
                    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": 242033,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:24.964520Z",
            "last_modified": "2024-02-14T14:43:24.387328Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/1600ac1b-4d8e-412d-a4e0-c455412ecf77/?format=api",
            "uuid": "1600ac1b-4d8e-412d-a4e0-c455412ecf77",
            "name": "Inlaat NG, Uitstroompeil",
            "code": "KDU-Q-7445_uitstroompeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    3.313583026230547,
                    47.97476598341171,
                    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": 14945,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:25.540674Z",
            "last_modified": "2022-01-18T07:37:18.504075Z",
            "last_modified_by": ""
        }
    ]
}