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

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=11",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=9",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/92aed1e6-1931-4324-8b28-9b4c1e643fa8/?format=api",
            "uuid": "92aed1e6-1931-4324-8b28-9b4c1e643fa8",
            "name": "Inlaat Ulkersluis, Ulkewegpeil inst.3",
            "code": "KDU-Q-5174#MPN-AS-1976",
            "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": 241304,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-11-30T18:34:05.425529Z",
            "last_modified": "2024-02-14T14:49:08.691824Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/46f5bb22-bd10-4631-a971-9980d20aab0e/?format=api",
            "uuid": "46f5bb22-bd10-4631-a971-9980d20aab0e",
            "name": "Inlaat Lochem Twentekanaal",
            "code": "ST80740031",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    6.385935359872152,
                    52.16619616132179,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/76b28794-719a-43cb-bdbb-2a3336fc3790/?format=api",
                "uuid": "76b28794-719a-43cb-bdbb-2a3336fc3790",
                "name": "IJGENZON"
            },
            "object": {
                "id": 216391,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-12-05T10:24:52.874152Z",
            "last_modified": "2021-07-26T09:44:56.695017Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/141ba632-55ae-4aa2-bd0b-daf42e68fb10/?format=api",
            "uuid": "141ba632-55ae-4aa2-bd0b-daf42e68fb10",
            "name": "Inlaat Herkel",
            "code": "ST84620011",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    6.347604602306157,
                    52.16665830229542,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/76b28794-719a-43cb-bdbb-2a3336fc3790/?format=api",
                "uuid": "76b28794-719a-43cb-bdbb-2a3336fc3790",
                "name": "IJGENZON"
            },
            "object": {
                "id": 216382,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-12-05T10:24:52.878929Z",
            "last_modified": "2021-07-26T09:44:47.135234Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/03b9d783-69fa-404d-9aee-de138e0d5524/?format=api",
            "uuid": "03b9d783-69fa-404d-9aee-de138e0d5524",
            "name": "Inlaat Barrièreweg ",
            "code": "KIN-V-10421::KSF",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    7.051996569123776,
                    52.72227279619143,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/244136f8-996c-4913-96b8-381ea218681d/?format=api",
                "uuid": "244136f8-996c-4913-96b8-381ea218681d",
                "name": "Waterschap Hunze en Aa's"
            },
            "object": {
                "id": 208476,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-12-13T13:31:56.236369Z",
            "last_modified": null,
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ecf9ac0d-de68-423d-ab68-edd10ce1c92f/?format=api",
            "uuid": "ecf9ac0d-de68-423d-ab68-edd10ce1c92f",
            "name": "Inlaat Purit ",
            "code": "KIN-V-10001::KSF",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    6.99641452853741,
                    52.72969778079261,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/244136f8-996c-4913-96b8-381ea218681d/?format=api",
                "uuid": "244136f8-996c-4913-96b8-381ea218681d",
                "name": "Waterschap Hunze en Aa's"
            },
            "object": {
                "id": 208473,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-12-13T13:32:59.176483Z",
            "last_modified": null,
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/314e2d38-b404-46ff-ad75-562b707e4291/?format=api",
            "uuid": "314e2d38-b404-46ff-ad75-562b707e4291",
            "name": "Inlaat Zuidervaart ",
            "code": "KIN-V-10039::KSF",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    7.039686144345706,
                    52.7275498386181,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/244136f8-996c-4913-96b8-381ea218681d/?format=api",
                "uuid": "244136f8-996c-4913-96b8-381ea218681d",
                "name": "Waterschap Hunze en Aa's"
            },
            "object": {
                "id": 208474,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-12-13T13:32:59.185096Z",
            "last_modified": null,
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2f5d63e3-1cec-48ea-8fc3-d2449f92c670/?format=api",
            "uuid": "2f5d63e3-1cec-48ea-8fc3-d2449f92c670",
            "name": "Inlaat Oosterdiep ",
            "code": "KIN-V-10401::KSF",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    7.039885475804696,
                    52.72851782696001,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/244136f8-996c-4913-96b8-381ea218681d/?format=api",
                "uuid": "244136f8-996c-4913-96b8-381ea218681d",
                "name": "Waterschap Hunze en Aa's"
            },
            "object": {
                "id": 208475,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2018-12-13T13:32:59.193635Z",
            "last_modified": null,
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/da52a48f-396f-48f8-8224-53b5ee2aa81e/?format=api",
            "uuid": "da52a48f-396f-48f8-8224-53b5ee2aa81e",
            "name": "Inlaat Voetakker",
            "code": "KDU-WS-4",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.205722286200191,
                    52.68157752750513,
                    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": 22426,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2019-10-01T10:43:48.682029Z",
            "last_modified": "2022-01-18T07:37:44.041824Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/fb01142e-e7f4-4656-8eba-332814eaeee3/?format=api",
            "uuid": "fb01142e-e7f4-4656-8eba-332814eaeee3",
            "name": "Inlaat Hoornse Vaart, Schuif bovenpeil",
            "code": "KDU-Q-722_schuif_bovenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.766797318238766,
                    52.641651199619304,
                    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": 22035,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-02-20T08:54:41.271798Z",
            "last_modified": "2022-01-18T07:38:16.879085Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/7c32b997-f43e-436f-9e93-73e1ac4859b1/?format=api",
            "uuid": "7c32b997-f43e-436f-9e93-73e1ac4859b1",
            "name": "Inlaat Hoornse Vaart, Schuif benedenpeil",
            "code": "KDU-Q-722_schuif_benedenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.766797318238766,
                    52.641651199619304,
                    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": 22035,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-02-20T08:54:41.272104Z",
            "last_modified": "2022-01-18T08:14:25.495294Z",
            "last_modified_by": ""
        }
    ]
}