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

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=19",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=17",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/1db517d8-f1ca-43d5-b8d1-3fdc03323bb2/?format=api",
            "uuid": "1db517d8-f1ca-43d5-b8d1-3fdc03323bb2",
            "name": "Inlaat Kolping Boys, Stand inlaat",
            "code": "KDU-Q-723_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.7774346417671,
                    52.63949915237871,
                    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": 22040,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.240538Z",
            "last_modified": "2022-01-18T07:39:27.616580Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/42a0e5f5-978d-40d2-a0d7-a3bf580c09d7/?format=api",
            "uuid": "42a0e5f5-978d-40d2-a0d7-a3bf580c09d7",
            "name": "Inlaat Obdam, Stand inlaat",
            "code": "KDU-Q-12428_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.877404308979381,
                    52.67849472251333,
                    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": 22041,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.240716Z",
            "last_modified": "2022-01-18T07:45:25.922758Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/06ad9bb5-ecab-44c8-8bd4-40740934240a/?format=api",
            "uuid": "06ad9bb5-ecab-44c8-8bd4-40740934240a",
            "name": "Inlaat Krabbedam, Stand inlaat",
            "code": "KDU-Q-718_stand_inlaat",
            "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.240896Z",
            "last_modified": "2022-01-18T07:39:27.166307Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/d7b71fec-bcbf-4134-8b3b-2ea7d00c9e3c/?format=api",
            "uuid": "d7b71fec-bcbf-4134-8b3b-2ea7d00c9e3c",
            "name": "Inlaat Kolhorn, Stand inlaat",
            "code": "KDU-Q-1958_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.903692134102156,
                    52.79261876912604,
                    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": 22043,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.241077Z",
            "last_modified": "2022-01-18T07:37:50.981455Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/7fdc2ace-d238-45ca-b058-9715f3f2df3b/?format=api",
            "uuid": "7fdc2ace-d238-45ca-b058-9715f3f2df3b",
            "name": "Inlaat Ulkersluis, Inl.stand Ulkeweg",
            "code": "KDU-Q-5174_inl.stand_ulkeweg",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907513856841739,
                    52.86670262541258,
                    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": 22088,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.241833Z",
            "last_modified": "2022-01-18T08:03:01.975222Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/29a5bdc3-56aa-498b-bf30-6fc210b74d5c/?format=api",
            "uuid": "29a5bdc3-56aa-498b-bf30-6fc210b74d5c",
            "name": "Inlaat Ulkersluis, Stand inlaat",
            "code": "KSL-Q-34185_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907513856841739,
                    52.86670262541258,
                    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": 36,
                "type": "sluice"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.242020Z",
            "last_modified": "2022-01-18T07:35:27.098148Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/b064482f-14e0-4d80-8111-2660e5afb0ad/?format=api",
            "uuid": "b064482f-14e0-4d80-8111-2660e5afb0ad",
            "name": "Inlaat Ulkersluis, Inl.stand Molenweg",
            "code": "KDU-Q-5174_inl.stand_molenweg",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.907513856841739,
                    52.86670262541258,
                    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": 22088,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.242198Z",
            "last_modified": "2022-01-18T07:39:15.995459Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/34f53cda-4389-444a-b088-e9444656228f/?format=api",
            "uuid": "34f53cda-4389-444a-b088-e9444656228f",
            "name": "Inlaat Tin, Stand inlaat",
            "code": "KDU-Q-688_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.831518095712499,
                    52.7838436495151,
                    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": 22053,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.243811Z",
            "last_modified": "2022-01-18T07:38:19.449461Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/0f236be6-632b-47f0-8ee2-baa76c60241e/?format=api",
            "uuid": "0f236be6-632b-47f0-8ee2-baa76c60241e",
            "name": "Inlaat/uitlaat schuif Rijweg, Stand inlaat",
            "code": "KDU-Q-12472_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.085229789846086,
                    52.685690629754006,
                    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": 22056,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.244722Z",
            "last_modified": "2022-01-18T07:38:58.918276Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3c9893b1-4625-476c-9668-ee6f7d705f8f/?format=api",
            "uuid": "3c9893b1-4625-476c-9668-ee6f7d705f8f",
            "name": "Inlaat Vier Noorder Koggen, Stand inlaat 1",
            "code": "KDU-Q-9876_schuif1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.117757900370498,
                    52.760185995425466,
                    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": 22061,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.245083Z",
            "last_modified": "2022-01-18T07:53:03.617351Z",
            "last_modified_by": ""
        }
    ]
}