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&page=3

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 59876,
    "next": "https://demo.lizard.net/api/v4/locations/?format=api&page=4",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&page=2",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/13bc925b-7664-4636-bee7-af3814c80e36/?format=api",
            "uuid": "13bc925b-7664-4636-bee7-af3814c80e36",
            "name": "Scheidingsvliet, instroom",
            "code": "KGM-A-369_in",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.73544361058399,
                    52.865077545173136,
                    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": 5595,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:31.579379Z",
            "last_modified": "2022-01-18T07:35:30.422957Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/6329a784-2990-4235-bd29-36a56a7100a8/?format=api",
            "uuid": "6329a784-2990-4235-bd29-36a56a7100a8",
            "name": "Spoorvijver",
            "code": "KGM-P-311000",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.012007460121332,
                    52.61966495341463,
                    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": 6997,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:37.727852Z",
            "last_modified": "2022-01-18T07:38:40.764677Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/0236616d-00fc-4629-85df-f598522e2aef/?format=api",
            "uuid": "0236616d-00fc-4629-85df-f598522e2aef",
            "name": "Vier Noorder Koggen gemaal, instroom (-2,20)",
            "code": "KGM-Q-31673_in(-2,20)",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.147082740172539,
                    52.73934627069197,
                    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": 6573,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:46.030757Z",
            "last_modified": "2022-01-18T08:26:53.347627Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/66ad3c40-c66f-4bff-a558-550c25211706/?format=api",
            "uuid": "66ad3c40-c66f-4bff-a558-550c25211706",
            "name": "Vier Noorder Koggen gemaal, instroom (-3,70)",
            "code": "KGM-Q-31673_in(-3,70)",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.147082740172539,
                    52.73934627069197,
                    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": 6573,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:46.245097Z",
            "last_modified": "2022-01-18T07:39:34.893371Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/8fdeb240-6ef1-4d93-8ec3-76371b9829fa/?format=api",
            "uuid": "8fdeb240-6ef1-4d93-8ec3-76371b9829fa",
            "name": "Volkstuinen Anna Paulowna",
            "code": "KGM-Q-25397",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.814464208627817,
                    52.87180428883091,
                    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": 6074,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:47.408476Z",
            "last_modified": "2022-01-18T07:37:52.871462Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/e409b32f-74b3-4699-908e-4128a02fb758/?format=api",
            "uuid": "e409b32f-74b3-4699-908e-4128a02fb758",
            "name": "Zwaan, instroom",
            "code": "KGM-Q-29208_in",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.745329635155759,
                    52.84714859803786,
                    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": 6155,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:26:06.974224Z",
            "last_modified": "2022-01-18T07:39:26.356997Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/f6782f59-62ae-4976-8a2f-006fb705b2a6/?format=api",
            "uuid": "f6782f59-62ae-4976-8a2f-006fb705b2a6",
            "name": "H-on",
            "code": "KDU-Q-6957",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.752858898491404,
                    52.79952275869057,
                    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": 22051,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:28:15.608621Z",
            "last_modified": "2022-01-18T07:38:49.903471Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/b10da8b3-df84-41c7-855d-d4dcf69767b6/?format=api",
            "uuid": "b10da8b3-df84-41c7-855d-d4dcf69767b6",
            "name": "Luijendijk",
            "code": "KSL-Q-8161",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.899738188481025,
                    52.4334979012271,
                    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": 10,
                "type": "sluice"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:28:35.264778Z",
            "last_modified": "2022-01-18T08:05:07.402893Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/8d51324f-86ab-4d3d-a15d-8ab91fc41802/?format=api",
            "uuid": "8d51324f-86ab-4d3d-a15d-8ab91fc41802",
            "name": "Busch en Dam",
            "code": "982",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.675045921587389,
                    52.54242436016523,
                    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": 203720,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:28:39.865868Z",
            "last_modified": "2022-01-18T07:38:14.236753Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/4d3a32d0-1ddc-43ba-a1b1-2a9fd3b46a95/?format=api",
            "uuid": "4d3a32d0-1ddc-43ba-a1b1-2a9fd3b46a95",
            "name": "Egmond",
            "code": "963",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.66760726885984,
                    52.623794480774976,
                    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": 203685,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:28:40.073607Z",
            "last_modified": "2022-01-18T07:35:24.457911Z",
            "last_modified_by": ""
        }
    ]
}