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

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=21",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=19",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/673cf662-61db-423d-846b-5ecfcc70719f/?format=api",
            "uuid": "673cf662-61db-423d-846b-5ecfcc70719f",
            "name": "Inlaat Oude Gouw, Stand inlaat",
            "code": "KDU-Q-9213_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.261350889344147,
                    52.70902421468398,
                    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": 22026,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.252503Z",
            "last_modified": "2022-01-18T07:38:05.164634Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/809af04f-1d33-439c-9f2a-5dd86fc77140/?format=api",
            "uuid": "809af04f-1d33-439c-9f2a-5dd86fc77140",
            "name": "Inlaat Monnickendam / De Nieuwendam, Stand spuisch",
            "code": "KDU-B-848_spuischuif1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.034302036719975,
                    52.46372783195455,
                    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": 22027,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.252743Z",
            "last_modified": "2022-01-18T08:28:27.460538Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/aa46f6ec-c875-44ed-8cda-61cb896c8235/?format=api",
            "uuid": "aa46f6ec-c875-44ed-8cda-61cb896c8235",
            "name": "Inlaat Monnickendam / De Nieuwendam, Stand spuisch",
            "code": "KDU-B-848_spuischuif2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.034302036719975,
                    52.46372783195455,
                    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": 22027,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.253001Z",
            "last_modified": "2022-01-18T07:39:06.815117Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/72981023-643b-4b5a-b3bb-bccc0f2b7fe8/?format=api",
            "uuid": "72981023-643b-4b5a-b3bb-bccc0f2b7fe8",
            "name": "Inlaat Hoornse Vaart, Stand inlaat",
            "code": "KGM-JL-2076_schuif",
            "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": 27347,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.253214Z",
            "last_modified": "2022-01-18T07:39:35.282256Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ae563162-ec0c-44fd-bbdb-af9ebee3b983/?format=api",
            "uuid": "ae563162-ec0c-44fd-bbdb-af9ebee3b983",
            "name": "Inlaat Krabbedam, Stand inlaat 2",
            "code": "KDU-Q-718_schuif2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.703009782330357,
                    52.732389804400114,
                    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": 22042,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.253406Z",
            "last_modified": "2022-01-18T07:37:26.214677Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/534143e9-953e-4fb0-a689-ff199e43d530/?format=api",
            "uuid": "534143e9-953e-4fb0-a689-ff199e43d530",
            "name": "Inlaat Krabbedam, Stand inlaat 1",
            "code": "KDU-Q-718_schuif1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.703009782330357,
                    52.732389804400114,
                    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": 22042,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.253591Z",
            "last_modified": "2022-01-18T07:39:09.059540Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2b98a17e-b0bd-4fbd-9eff-2d0f97101bd6/?format=api",
            "uuid": "2b98a17e-b0bd-4fbd-9eff-2d0f97101bd6",
            "name": "Inlaat Oudorp, Stand inlaat",
            "code": "KDU-Q-729_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.765136984048264,
                    52.62417692799981,
                    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": 22044,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.253795Z",
            "last_modified": "2022-01-18T07:46:56.961398Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/44a6f27b-5e1e-4495-97df-8acbb5144fcd/?format=api",
            "uuid": "44a6f27b-5e1e-4495-97df-8acbb5144fcd",
            "name": "Inlaat Houtpolder / Meilag, Stand stuw",
            "code": "KDU-Q-13304_stuw",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.244967657591505,
                    52.68329587660334,
                    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": 22058,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.253977Z",
            "last_modified": "2022-01-18T08:26:02.268541Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/8ec8f522-a173-4e1d-8a48-6ec5d2c73d54/?format=api",
            "uuid": "8ec8f522-a173-4e1d-8a48-6ec5d2c73d54",
            "name": "Inlaatschuif berging Diepgatweg, Schuif stand Zuid",
            "code": "KST-Q-19380_schuif_stand_zuid",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.803563151965908,
                    52.71822056323833,
                    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": 22434,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:18:20.870266Z",
            "last_modified": "2022-01-18T07:43:03.703627Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2e6b9e9b-c65f-4448-9eed-65efadceb140/?format=api",
            "uuid": "2e6b9e9b-c65f-4448-9eed-65efadceb140",
            "name": "Inlaatschuif berging Diepgatweg, Stand schuif Noor",
            "code": "KST-Q-19380_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.803563151965908,
                    52.71822056323833,
                    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": 22434,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:18:20.870454Z",
            "last_modified": "2022-01-18T08:22:02.612449Z",
            "last_modified_by": ""
        }
    ]
}