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

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=7",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=5",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/4608f25e-79b4-4a74-ab67-ecdbd822f685/?format=api",
            "uuid": "4608f25e-79b4-4a74-ab67-ecdbd822f685",
            "name": "Inlaat Wieringerrandweg, Benedenpeil",
            "code": "KDU-Q-7452_benedenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.971511194678751,
                    52.89059159991037,
                    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": 4657,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:28.986290Z",
            "last_modified": "2022-01-18T07:37:52.065271Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/76d695a3-b72c-4bd9-8e55-9af9a05da036/?format=api",
            "uuid": "76d695a3-b72c-4bd9-8e55-9af9a05da036",
            "name": "Inlaat Wieringerrandweg, Bovenpeil",
            "code": "KDU-Q-7452_bovenpeil",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.971511194678751,
                    52.89059159991037,
                    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": 4657,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T10:49:29.093595Z",
            "last_modified": "2022-01-18T08:00:44.653831Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/141395cb-e148-4eb5-bcb0-2c6789ccee22/?format=api",
            "uuid": "141395cb-e148-4eb5-bcb0-2c6789ccee22",
            "name": "Inlaat Oostzaan, Benedenpeil",
            "code": "KDU-Q-28114#MPN-AS-1073",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.908107387970944,
                    52.48294656930793,
                    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": 240582,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T14:11:38.469504Z",
            "last_modified": "2024-02-14T14:43:44.506078Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/573d85c7-868c-4ae6-bf67-9d2202e5f506/?format=api",
            "uuid": "573d85c7-868c-4ae6-bf67-9d2202e5f506",
            "name": "Inlaat Oostzaan, Bovenpeil",
            "code": "KDU-Q-28114#MPN-AS-1072",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.908107387970944,
                    52.48294656930793,
                    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": 240581,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-09-13T14:11:38.543988Z",
            "last_modified": "2024-02-14T14:43:44.919952Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2d634a82-e56d-46c6-b60b-258e93bc1c20/?format=api",
            "uuid": "2d634a82-e56d-46c6-b60b-258e93bc1c20",
            "name": "Inlaat Waardweg, Benedenpeil 2",
            "code": "KDU-Q-2348_benedenpeil_2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.896530187898223,
                    52.83353852769232,
                    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": 456,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:17.748728Z",
            "last_modified": "2022-01-18T07:35:34.804400Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/1d516baa-1e01-4bca-bbab-d3d9733aad95/?format=api",
            "uuid": "1d516baa-1e01-4bca-bbab-d3d9733aad95",
            "name": "Inlaat Immerhorn, Uitstroompeil",
            "code": "KDU-A-957#MPN-AS-683",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.283172610914975,
                    52.72198322389129,
                    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": 241852,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:17.829595Z",
            "last_modified": "2024-02-14T14:44:08.954827Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3b8761f2-e2b2-4d56-8d21-7b237521d127/?format=api",
            "uuid": "3b8761f2-e2b2-4d56-8d21-7b237521d127",
            "name": "Inlaat Immerhorn, Kooizandpeil",
            "code": "KDU-A-957_kooizandpeil",
            "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": 494,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:17.930483Z",
            "last_modified": "2022-01-18T08:19:37.862124Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/71735a94-f194-40b3-aa20-13d2dfa9e1d0/?format=api",
            "uuid": "71735a94-f194-40b3-aa20-13d2dfa9e1d0",
            "name": "Inlaat Immerhorn, Ijsselmeerpeil",
            "code": "KDU-A-957_ijsselmeerpeil",
            "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": 494,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:18.003646Z",
            "last_modified": "2022-01-18T07:39:31.107073Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2474bd56-ad68-45bc-8a77-9983c540f142/?format=api",
            "uuid": "2474bd56-ad68-45bc-8a77-9983c540f142",
            "name": "Inlaat Rekerdijk 1, Benedenpeil 1",
            "code": "KDU-Q-721#MPN-AS-1607",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.756547681468335,
                    52.64074639137937,
                    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": 22033,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:18.086375Z",
            "last_modified": "2022-01-18T08:19:25.485350Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/925de415-d8f5-49d5-a85d-df0e89210175/?format=api",
            "uuid": "925de415-d8f5-49d5-a85d-df0e89210175",
            "name": "Inlaat Rekerdijk 1, Benedenpeil 2",
            "code": "KDU-Q-721#MPN-AS-1608",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.756547681468335,
                    52.64074639137937,
                    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": 22033,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:18.151338Z",
            "last_modified": "2022-01-18T08:20:20.495389Z",
            "last_modified_by": ""
        }
    ]
}