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

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=3",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/125926ae-2373-4ff4-9850-f4a0c75f9eac/?format=api",
            "uuid": "125926ae-2373-4ff4-9850-f4a0c75f9eac",
            "name": "Laeg t gemaal, uitstroom",
            "code": "KGM-A-930_uit",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.966899175076159,
                    52.71748477354515,
                    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": 7358,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:02.270987Z",
            "last_modified": "2022-01-18T07:38:26.798674Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/881d8232-9829-45c3-b77a-7381ee165f0a/?format=api",
            "uuid": "881d8232-9829-45c3-b77a-7381ee165f0a",
            "name": "Mars (de), instroom",
            "code": "KGM-Q-29206_in",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.802622604578388,
                    53.05822111924456,
                    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": null,
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:06.424910Z",
            "last_modified": "2022-01-18T07:35:31.105331Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/fc327be0-ceb4-4afb-ad61-0e1b44375cae/?format=api",
            "uuid": "fc327be0-ceb4-4afb-ad61-0e1b44375cae",
            "name": "Mars (de), uitstroom",
            "code": "KGM-Q-29206_uit",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.802622604578388,
                    53.05822111924456,
                    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": null,
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:06.623492Z",
            "last_modified": "2022-01-18T07:39:06.065814Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3ad3fc8a-3701-428f-ab2e-8695aa4c6856/?format=api",
            "uuid": "3ad3fc8a-3701-428f-ab2e-8695aa4c6856",
            "name": "Menningweer, instroom",
            "code": "KGM-Q-20439_in",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.839674503435623,
                    52.58743536044665,
                    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": 5670,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:07.477178Z",
            "last_modified": "2022-01-18T07:39:11.299369Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/9de2319e-9a43-4dfa-adb9-b2bfd405cb41/?format=api",
            "uuid": "9de2319e-9a43-4dfa-adb9-b2bfd405cb41",
            "name": "Menningweer, uitstroom",
            "code": "KGM-Q-20439_uit",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.839674503435623,
                    52.58743536044665,
                    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": 5670,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:07.680762Z",
            "last_modified": "2022-01-18T07:39:00.095579Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2acaee61-6ca9-4c50-b332-8fe87894f1f2/?format=api",
            "uuid": "2acaee61-6ca9-4c50-b332-8fe87894f1f2",
            "name": "De Kaag",
            "code": "KGM-Q-31641",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.929330056389002,
                    52.68895138797973,
                    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": 6726,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:09.635505Z",
            "last_modified": "2022-01-18T08:14:35.558965Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/c33114c2-122b-4194-a4c6-3530d2438cbe/?format=api",
            "uuid": "c33114c2-122b-4194-a4c6-3530d2438cbe",
            "name": "NM-Zuid, boezem",
            "code": "KGM-Q-29112_boezem",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.696311396596539,
                    52.77411661247911,
                    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": 6829,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:11.639111Z",
            "last_modified": "2022-01-18T07:39:36.705999Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/41ef78f1-67bb-4265-8f54-9941cd064213/?format=api",
            "uuid": "41ef78f1-67bb-4265-8f54-9941cd064213",
            "name": "NM-Zuid, instroom",
            "code": "KGM-Q-29112_in",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.696311396596539,
                    52.77411661247911,
                    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": 6829,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:11.824894Z",
            "last_modified": "2022-01-18T08:25:20.527826Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/7eac854d-89fa-41d2-a271-1fc4fb0452ed/?format=api",
            "uuid": "7eac854d-89fa-41d2-a271-1fc4fb0452ed",
            "name": "Oudendijk Oost",
            "code": "KGM-JG-350",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.995005711871558,
                    52.6025573050338,
                    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": 7302,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:20.682348Z",
            "last_modified": "2022-01-18T08:16:28.761675Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/b10a6791-76c1-4466-b3b7-c7d8a03d6af9/?format=api",
            "uuid": "b10a6791-76c1-4466-b3b7-c7d8a03d6af9",
            "name": "Oudendijk West",
            "code": "KGM-JG-349",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.99323516659582,
                    52.60231300099481,
                    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": 7303,
                "type": "pumpstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2014-11-05T10:25:20.865943Z",
            "last_modified": "2022-01-18T08:25:57.733020Z",
            "last_modified_by": ""
        }
    ]
}