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

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=3",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/fab87004-bf24-4492-a605-636c6ea8e908/?format=api",
            "uuid": "fab87004-bf24-4492-a605-636c6ea8e908",
            "name": "Inlaat A, Benedenpeil",
            "code": "KDU-Q-3520#MPN-AS-1228",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.697219846149037,
                    52.73381052450254,
                    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": 240731,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:20.894675Z",
            "last_modified": "2024-02-14T14:43:10.006529Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ce6cf9ed-05d7-4f3e-863c-a4cce67bf8cd/?format=api",
            "uuid": "ce6cf9ed-05d7-4f3e-863c-a4cce67bf8cd",
            "name": "Inlaat A, Bovenpeil",
            "code": "KDU-Q-3520#MPN-AS-1227",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.697219846149037,
                    52.73381052450254,
                    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": 240730,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:20.966172Z",
            "last_modified": "2024-02-14T14:43:11.507771Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/d247ce3a-54b7-429c-919e-7aea37444f67/?format=api",
            "uuid": "d247ce3a-54b7-429c-919e-7aea37444f67",
            "name": "Inlaat Aurora, Instroompeil",
            "code": "KDU-Q-32931#MPN-AS-795",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.940422491056757,
                    52.7010248805657,
                    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": 241955,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:21.035614Z",
            "last_modified": "2024-02-14T14:43:11.918564Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/0b9c3e32-ae48-4e65-aeb3-fb5db03bc5ae/?format=api",
            "uuid": "0b9c3e32-ae48-4e65-aeb3-fb5db03bc5ae",
            "name": "Inlaat Aurora, Benedenpeil 1",
            "code": "KDU-Q-32931#MPN-AS-794",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.940422491056757,
                    52.7010248805657,
                    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": 241954,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:21.109255Z",
            "last_modified": "2024-02-14T14:43:12.461074Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/236383e1-eba9-4a49-ae19-6b523e354ae6/?format=api",
            "uuid": "236383e1-eba9-4a49-ae19-6b523e354ae6",
            "name": "Inlaat Aurora, Benedenpeil 2",
            "code": "KDU-Q-32931#MPN-AS-793",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.940422491056757,
                    52.7010248805657,
                    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": 241953,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:21.185081Z",
            "last_modified": "2024-02-14T14:43:12.960501Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/72535f81-6ec3-403e-b874-a78bf37a53fb/?format=api",
            "uuid": "72535f81-6ec3-403e-b874-a78bf37a53fb",
            "name": "Inlaat Wijdenes, Benedenpeil 2",
            "code": "KDU-Q-11880#MPN-AS-724",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.171122838733168,
                    52.63139255834431,
                    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": 241886,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:21.534101Z",
            "last_modified": "2024-02-14T14:43:13.373138Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/9665db48-32e9-46b6-ae5d-e7f02e4c8041/?format=api",
            "uuid": "9665db48-32e9-46b6-ae5d-e7f02e4c8041",
            "name": "Inlaat Wijdenes, Benedenpeil 1",
            "code": "KDU-Q-11880#MPN-AS-723",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.171122838733168,
                    52.63139255834431,
                    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": 241885,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:21.643004Z",
            "last_modified": "2024-02-14T14:43:13.781248Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/a641c8f8-53b7-4997-979b-c9ac49546bfd/?format=api",
            "uuid": "a641c8f8-53b7-4997-979b-c9ac49546bfd",
            "name": "Inlaat Wijdenes, Bovenpeil",
            "code": "KDU-Q-11880#MPN-AS-725",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.171122838733168,
                    52.63139255834431,
                    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": 241887,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:21.745203Z",
            "last_modified": "2024-02-14T14:43:14.177128Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/cd507fc6-8e7b-432b-8394-16e8ef97ded5/?format=api",
            "uuid": "cd507fc6-8e7b-432b-8394-16e8ef97ded5",
            "name": "Inlaat Grote Sloot noord, Benedenpeil",
            "code": "KDU-Q-5262#MPN-AS-1326",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.742467332513849,
                    52.79445678702454,
                    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": 240776,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:22.020865Z",
            "last_modified": "2024-02-14T14:43:14.979774Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/49f24f10-bf05-4b55-8169-8f040cc0419f/?format=api",
            "uuid": "49f24f10-bf05-4b55-8169-8f040cc0419f",
            "name": "Inlaat Grote Sloot noord, Bovenpeil",
            "code": "KDU-Q-5262#MPN-AS-1325",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.742467332513849,
                    52.79445678702454,
                    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": 240775,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:22.134113Z",
            "last_modified": "2024-02-14T14:43:15.376963Z",
            "last_modified_by": "bkropf"
        }
    ]
}