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

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=10",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=8",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/99737eee-69ed-412c-a11d-9a34e2aef6bb/?format=api",
            "uuid": "99737eee-69ed-412c-a11d-9a34e2aef6bb",
            "name": "Inlaat Monnickendam / De Nieuwendam, Gouwzee",
            "code": "KDU-B-848#MPN-AS-439",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.034322205101024,
                    52.463742489955614,
                    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": 241611,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2017-12-04T22:28:22.258852Z",
            "last_modified": "2024-02-14T14:48:43.802469Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/4f9e61b7-a458-4f85-8591-15dddb122208/?format=api",
            "uuid": "4f9e61b7-a458-4f85-8591-15dddb122208",
            "name": "Inlaat Vier Noorder Koggen, Bovenpeil",
            "code": "KDU-Q-9876#MPN-AS-751",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.117628516139238,
                    52.76016044524673,
                    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": 241912,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-05-01T09:45:12.232830Z",
            "last_modified": "2024-02-14T14:48:55.280964Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ece74597-840d-4f31-b845-4091ac3daa7d/?format=api",
            "uuid": "ece74597-840d-4f31-b845-4091ac3daa7d",
            "name": "Inlaat Rustenburg, Raakmaatsboezem",
            "code": "KDU-Q-34021#MPN-AS-416",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.876439499362208,
                    52.634328049176,
                    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": 241588,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-06-28T14:03:12.701879Z",
            "last_modified": "2024-02-14T14:48:56.850875Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/6dcb7dc4-5c76-4fbd-8f1e-337dca654cdb/?format=api",
            "uuid": "6dcb7dc4-5c76-4fbd-8f1e-337dca654cdb",
            "name": "Inlaat Rustenburg, Schermerboezem",
            "code": "KDU-Q-34021#MPN-AS-417",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.876439499362208,
                    52.634328049176,
                    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": 241589,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-06-28T14:03:20.125797Z",
            "last_modified": "2024-02-14T14:48:57.672393Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/e5d19e72-9f07-4336-9264-5d669b576e75/?format=api",
            "uuid": "e5d19e72-9f07-4336-9264-5d669b576e75",
            "name": "Inlaat Ulkersluis, Instroompeil",
            "code": "KDU-Q-5174_instroompeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907513856841739,
                    52.86670262541258,
                    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": 22088,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-11-30T18:34:05.422184Z",
            "last_modified": "2022-01-18T07:39:31.873385Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/68336acd-3dbd-40ea-a4cf-ee5d34c3eb50/?format=api",
            "uuid": "68336acd-3dbd-40ea-a4cf-ee5d34c3eb50",
            "name": "Inlaat Ulkersluis, Ulkewegpeil inst.1",
            "code": "KDU-Q-5174#MPN-AS-1974",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907744550424552,
                    52.86665767568879,
                    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": 241302,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-11-30T18:34:05.423726Z",
            "last_modified": "2024-02-14T14:49:06.211205Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/4e00dd4a-3f96-48fd-b65f-62ce89ff02b5/?format=api",
            "uuid": "4e00dd4a-3f96-48fd-b65f-62ce89ff02b5",
            "name": "Inlaat Ulkersluis, Ulkewegpeil inst.4",
            "code": "KDU-Q-5174#MPN-AS-1972",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907744550424552,
                    52.86665767568879,
                    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": 241300,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-11-30T18:34:05.424038Z",
            "last_modified": "2024-02-14T14:49:06.747542Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/8ed234b5-5308-4b9f-a25e-b54b00d0bcb6/?format=api",
            "uuid": "8ed234b5-5308-4b9f-a25e-b54b00d0bcb6",
            "name": "Inlaat Ulkersluis, Molenweg peil",
            "code": "KDU-Q-5174#MPN-AS-1973",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907744550424552,
                    52.86665767568879,
                    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": 241301,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-11-30T18:34:05.424338Z",
            "last_modified": "2024-02-14T14:49:07.169175Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/39172773-96ac-4fb5-a375-4e419eec45f3/?format=api",
            "uuid": "39172773-96ac-4fb5-a375-4e419eec45f3",
            "name": "Inlaat Ulkersluis, Uitstroompeil",
            "code": "KDU-Q-5174#MPN-AS-1878",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907744550424552,
                    52.86665767568879,
                    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": 241241,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-11-30T18:34:05.424944Z",
            "last_modified": "2024-02-14T14:49:07.922705Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ad7039d2-4cf1-4d58-9c9c-8a2611fa23b4/?format=api",
            "uuid": "ad7039d2-4cf1-4d58-9c9c-8a2611fa23b4",
            "name": "Inlaat Ulkersluis, Ulkewegpeil inst.2",
            "code": "KDU-Q-5174#MPN-AS-1975",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907744550424552,
                    52.86665767568879,
                    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": 241303,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-11-30T18:34:05.425231Z",
            "last_modified": "2024-02-14T14:49:08.295010Z",
            "last_modified_by": "bkropf"
        }
    ]
}