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

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=6",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=4",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/eab352eb-8d3d-454b-9e47-9160e19dbbc0/?format=api",
            "uuid": "eab352eb-8d3d-454b-9e47-9160e19dbbc0",
            "name": "Inlaat Oudorp, Instroompeil",
            "code": "KDU-Q-729#MPN-AS-1641",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.765394929531449,
                    52.62437386030854,
                    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": 241008,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:27.296485Z",
            "last_modified": "2024-02-14T14:43:31.892134Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/d2990133-cbd4-490f-b8d4-f9f6b9c11189/?format=api",
            "uuid": "d2990133-cbd4-490f-b8d4-f9f6b9c11189",
            "name": "Inlaat/uitlaat schuif Rijweg, Benedenpeil",
            "code": "KDU-Q-12472#MPN-AS-825",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.08538505326236,
                    52.68577391299688,
                    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": 241984,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:27.760288Z",
            "last_modified": "2024-02-14T14:43:33.189808Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/d9243822-48d7-4db7-8e43-c82193140df0/?format=api",
            "uuid": "d9243822-48d7-4db7-8e43-c82193140df0",
            "name": "Inlaat/uitlaat schuif Rijweg, Bovenpeil",
            "code": "KDU-Q-12472#MPN-AS-824",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.08538505326236,
                    52.68577391299688,
                    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": 241983,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:27.893551Z",
            "last_modified": "2024-02-14T14:43:33.880756Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/86684f09-1308-48f0-bca9-94b0f4278c5f/?format=api",
            "uuid": "86684f09-1308-48f0-bca9-94b0f4278c5f",
            "name": "Inlaat Veenhuizerpolder, Bovenpeil",
            "code": "KDU-Q-696#MPN-AS-1668",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.88556601125482,
                    52.70961830356123,
                    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": 241031,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:27.997884Z",
            "last_modified": "2024-02-14T14:43:34.288980Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/284ad935-349f-42d3-9c73-3815ea240952/?format=api",
            "uuid": "284ad935-349f-42d3-9c73-3815ea240952",
            "name": "Inlaat Veenhuizerpolder, Uitstroompeil",
            "code": "KDU-Q-696#MPN-AS-1669",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.88556601125482,
                    52.70961830356123,
                    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": 22036,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:28.103020Z",
            "last_modified": "2022-01-18T07:37:34.494499Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/dfe95a44-85f2-4824-91a6-430530cc55d7/?format=api",
            "uuid": "dfe95a44-85f2-4824-91a6-430530cc55d7",
            "name": "Inlaat Schellinkhout-Dorp, Benedenpeil",
            "code": "KDU-Q-15007#MPN-AS-746",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.125302330397305,
                    52.63066609386418,
                    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": 241976,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:28.214914Z",
            "last_modified": "2024-02-14T14:43:34.815900Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/4c98ad52-f39c-44b4-ab1e-a63a3918376f/?format=api",
            "uuid": "4c98ad52-f39c-44b4-ab1e-a63a3918376f",
            "name": "Inlaat Schellinkhout-Dorp, Nivo Putpeil",
            "code": "KDU-Q-15007#MPN-AS-1968",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.125302330397305,
                    52.63066609386418,
                    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": 241296,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:28.315297Z",
            "last_modified": "2024-02-14T14:43:35.245445Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/85eb3c33-e235-4e9e-8912-8467ff2d181a/?format=api",
            "uuid": "85eb3c33-e235-4e9e-8912-8467ff2d181a",
            "name": "Inlaat Ursem, Benedenpeil",
            "code": "KDU-Q-11372_benedenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.884008968290925,
                    52.63263584466134,
                    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": 15447,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:28.422753Z",
            "last_modified": "2022-01-18T08:11:15.473035Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/89912fd7-651b-4393-a248-be3114fe9d40/?format=api",
            "uuid": "89912fd7-651b-4393-a248-be3114fe9d40",
            "name": "Inlaat Vier Noorder Koggen, Bovenpeil",
            "code": "KDU-Q-9919_bovenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.117761569572553,
                    52.76017469832792,
                    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": 14340,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:28.528697Z",
            "last_modified": "2022-01-18T07:39:02.283549Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/9da456ad-956a-40ab-840e-8820cdf3ba9c/?format=api",
            "uuid": "9da456ad-956a-40ab-840e-8820cdf3ba9c",
            "name": "Inlaat Wieringerrandweg, Instroompeil",
            "code": "KDU-Q-7452_instroompeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.971511194678751,
                    52.89059159991037,
                    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": 4657,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:28.875246Z",
            "last_modified": "2022-01-18T07:37:46.291217Z",
            "last_modified_by": ""
        }
    ]
}