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

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=17",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=15",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/db7d92cd-111b-4d97-94aa-79208a6dd020/?format=api",
            "uuid": "db7d92cd-111b-4d97-94aa-79208a6dd020",
            "name": "Inlaat Immerhorn, Stand inlaat 1",
            "code": "KDU-A-957_schuif1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.283637663425575,
                    52.72198896893235,
                    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": 22057,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.235732Z",
            "last_modified": "2022-01-18T07:38:23.177610Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ff0f2e90-d18c-4144-b8ac-5230edc28b31/?format=api",
            "uuid": "ff0f2e90-d18c-4144-b8ac-5230edc28b31",
            "name": "Inlaat Immerhorn, Stand inlaat 2",
            "code": "KDU-A-957_schuif2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.283637663425575,
                    52.72198896893235,
                    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": 22057,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.235914Z",
            "last_modified": "2022-01-18T07:37:48.617837Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/0502d04f-21a6-41bb-a745-85f26b952bb4/?format=api",
            "uuid": "0502d04f-21a6-41bb-a745-85f26b952bb4",
            "name": "Inlaat Voetakker, Stand aflaat",
            "code": "KDU-WS-4_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.205721594626427,
                    52.68157839633899,
                    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": "2020-07-16T13:15:01.236095Z",
            "last_modified": "2022-01-18T08:02:09.634041Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/231bbf5d-d207-48f6-95cc-d4d0b504fb3f/?format=api",
            "uuid": "231bbf5d-d207-48f6-95cc-d4d0b504fb3f",
            "name": "Inlaat De Spuiter, Stand inlaat",
            "code": "KDU-Q-31718_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.207538541907192,
                    52.64497288319526,
                    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": 22464,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.236273Z",
            "last_modified": "2022-01-18T07:55:00.732916Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/c15d9623-c3c9-47c1-951c-67a361769896/?format=api",
            "uuid": "c15d9623-c3c9-47c1-951c-67a361769896",
            "name": "Inlaat Westerkogge, Stand inlaat",
            "code": "KDU-Q-9996_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.020278439815982,
                    52.63354704269336,
                    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": 22031,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.236450Z",
            "last_modified": "2022-01-18T08:21:40.698854Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/f519f755-6570-4078-853b-e3cf2a16f6f6/?format=api",
            "uuid": "f519f755-6570-4078-853b-e3cf2a16f6f6",
            "name": "Inlaat Rustenburg, Stand inlaat 1",
            "code": "KDU-Q-34021_schuif1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.876434691468914,
                    52.634376429941476,
                    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": 22089,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.236806Z",
            "last_modified": "2022-01-18T07:37:25.338821Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/eea81366-0913-486c-a4df-858584fd4865/?format=api",
            "uuid": "eea81366-0913-486c-a4df-858584fd4865",
            "name": "Inlaat Rustenburg, Stand inlaat 2",
            "code": "KDU-Q-34021_schuif2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.876434691468914,
                    52.634376429941476,
                    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": 22089,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.236990Z",
            "last_modified": "2022-01-18T07:39:35.403136Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/01f98e8b-e3cc-447f-81ab-9f5201d29391/?format=api",
            "uuid": "01f98e8b-e3cc-447f-81ab-9f5201d29391",
            "name": "Inlaat Wijdenes, Stand inlaat",
            "code": "KDU-WS-2_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.170816363522964,
                    52.631515803169236,
                    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": 22467,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.237172Z",
            "last_modified": "2022-01-18T07:37:25.184856Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/1bfb7e5b-572c-4fe5-9d62-821f7e19128b/?format=api",
            "uuid": "1bfb7e5b-572c-4fe5-9d62-821f7e19128b",
            "name": "Inlaat Schellinkhout-Dorp, Stand inlaat 2",
            "code": "KDU-Q-15007_schuif2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.125301525141346,
                    52.63066692175116,
                    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": 22059,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.237351Z",
            "last_modified": "2022-01-18T08:03:11.900053Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ed6ab58a-00f5-4a55-83c2-af48c0c03c77/?format=api",
            "uuid": "ed6ab58a-00f5-4a55-83c2-af48c0c03c77",
            "name": "Inlaat Schellinkhout-Dorp, Stand inlaat 1",
            "code": "KDU-Q-15007_schuif1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.125301525141346,
                    52.63066692175116,
                    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": 22059,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.237530Z",
            "last_modified": "2022-01-18T07:37:51.165444Z",
            "last_modified_by": ""
        }
    ]
}