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

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=12",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=10",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/6a773131-b9ab-4654-8b29-113e8793fbcf/?format=api",
            "uuid": "6a773131-b9ab-4654-8b29-113e8793fbcf",
            "name": "Inlaat Wijdenes, Benedenpeil",
            "code": "KDU-WS-2_benedenpeil",
            "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-04-10T21:35:55.352623Z",
            "last_modified": "2022-01-18T07:39:13.080213Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/a769d103-0ba1-43f6-9c65-1ef8d7d4e61f/?format=api",
            "uuid": "a769d103-0ba1-43f6-9c65-1ef8d7d4e61f",
            "name": "Inlaatwerk Lemmer (Slump), waterhoogte LWZ",
            "code": "IW4510-LT2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.716722245325924,
                    52.84244243424737,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23050,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T15:46:19.932753Z",
            "last_modified": "2022-01-18T03:26:45.293526Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/65e6fcc5-aa37-4e64-aa0a-182d2f94625e/?format=api",
            "uuid": "65e6fcc5-aa37-4e64-aa0a-182d2f94625e",
            "name": "Inlaat Lemsterhop, waterhoogte HWZ",
            "code": "IW4520-LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.721279470801213,
                    52.84448768686686,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23052,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.472764Z",
            "last_modified": "2022-01-18T03:46:02.702277Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/e6a85127-4308-4fb8-b467-14c49200160d/?format=api",
            "uuid": "e6a85127-4308-4fb8-b467-14c49200160d",
            "name": "Inlaatwerk Blokzijl, waterhoogte LWZ",
            "code": "IW4530-LT2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.956963642376497,
                    52.72476067893209,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23055,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.472962Z",
            "last_modified": "2022-01-18T03:32:02.544180Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/746df97f-3258-488c-af88-2e1503881096/?format=api",
            "uuid": "746df97f-3258-488c-af88-2e1503881096",
            "name": "Inlaatwerk Lemmer (Slump), waterhoogte HWZ",
            "code": "IW4510-LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.716722245325924,
                    52.84244243424737,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23050,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.474372Z",
            "last_modified": "2022-01-18T03:33:40.414479Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/078388d0-3db6-4ec3-9dfb-f6782975ec95/?format=api",
            "uuid": "078388d0-3db6-4ec3-9dfb-f6782975ec95",
            "name": "Inlaatwerk Lemmer/Rutten, waterhoogte tussenpand",
            "code": "IW4500-LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.70468320206963,
                    52.83394679379565,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23057,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.474560Z",
            "last_modified": "2022-01-18T03:18:18.557859Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/dbfea829-333a-4d7a-bdce-4b9990dd7ce3/?format=api",
            "uuid": "dbfea829-333a-4d7a-bdce-4b9990dd7ce3",
            "name": "Inlaatwerk Ramspol, waterhoogte LWZ",
            "code": "IW4540-LT2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.851221742661465,
                    52.61600886236202,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23054,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.474944Z",
            "last_modified": "2022-01-18T03:33:27.956812Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/4de54c66-e94c-42a4-ad44-07151c0ef3b8/?format=api",
            "uuid": "4de54c66-e94c-42a4-ad44-07151c0ef3b8",
            "name": "Inlaat Kanaalweg, waterhoogte HWZ",
            "code": "IW4535-LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.951099388641039,
                    52.71189220229095,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23053,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.475176Z",
            "last_modified": "2022-01-18T03:35:44.424953Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/b5401c7c-4bc3-4aae-a7ce-2a69e0770c22/?format=api",
            "uuid": "b5401c7c-4bc3-4aae-a7ce-2a69e0770c22",
            "name": "Inlaatwerk Ramspol, waterhoogte tussenpand",
            "code": "IW4540-LT1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.851221742661465,
                    52.61600886236202,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23054,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.476388Z",
            "last_modified": "2022-01-18T03:18:05.250229Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/8aac15bf-a163-42c3-98d9-a3c4dac8c08a/?format=api",
            "uuid": "8aac15bf-a163-42c3-98d9-a3c4dac8c08a",
            "name": "Inlaat Kanaalweg, waterhoogte LWZ",
            "code": "IW4535-LT2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.951099388641039,
                    52.71189220229095,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23053,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-08T19:46:27.477506Z",
            "last_modified": "2022-01-18T03:50:13.785179Z",
            "last_modified_by": "emile.debadts"
        }
    ]
}