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

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=8",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=6",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/fc020f8c-a02a-46d3-ac2b-09391500c13f/?format=api",
            "uuid": "fc020f8c-a02a-46d3-ac2b-09391500c13f",
            "name": "Inlaat Rekerdijk 1, Bovenpeil",
            "code": "KDU-Q-721#MPN-AS-1606",
            "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.218217Z",
            "last_modified": "2022-01-18T08:20:40.482047Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/9891f442-2600-4728-a31c-0574d4ac5676/?format=api",
            "uuid": "9891f442-2600-4728-a31c-0574d4ac5676",
            "name": "Inlaat Spanbroek, Benedenpeil",
            "code": "KDU-N-1000#MPN-AS-814",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.942379138765678,
                    52.69818659438309,
                    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": 241089,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:32.170935Z",
            "last_modified": "2024-02-14T14:44:09.390454Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3a47fe83-b531-4f30-bc2b-b6fd03d56d9c/?format=api",
            "uuid": "3a47fe83-b531-4f30-bc2b-b6fd03d56d9c",
            "name": "Inlaat Spanbroek, Bovenpeil",
            "code": "KDU-N-1000#MPN-AS-813",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.942379138765678,
                    52.69818659438309,
                    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": 241974,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:32.261080Z",
            "last_modified": "2024-02-14T14:44:09.795768Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/4e79aff2-69c5-4162-92b7-451ddd0f0457/?format=api",
            "uuid": "4e79aff2-69c5-4162-92b7-451ddd0f0457",
            "name": "Inlaat Tin, Instroompeil",
            "code": "KDU-Q-688#MPN-AS-968",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.83151255444795,
                    52.78377337762841,
                    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": 242128,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:32.348024Z",
            "last_modified": "2024-02-14T14:44:10.205339Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/47c3d736-8c27-43ea-bebb-1e230df8275e/?format=api",
            "uuid": "47c3d736-8c27-43ea-bebb-1e230df8275e",
            "name": "Inlaat Tin, Uitstroompeil",
            "code": "KDU-Q-688#MPN-AS-969",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.83151255444795,
                    52.78377337762841,
                    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": 242129,
                "type": "measuringstation"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-10-19T04:27:32.436964Z",
            "last_modified": "2024-02-14T14:44:10.593605Z",
            "last_modified_by": "bkropf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/53730861-ef46-4ac3-a1fc-9982c01e0cfd/?format=api",
            "uuid": "53730861-ef46-4ac3-a1fc-9982c01e0cfd",
            "name": "Inlaat Oude Gouw, Temperatuur water",
            "code": "KDU-Q-9213_temperatuur_water",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.261350889344147,
                    52.70902421468398,
                    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": 14395,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-11-15T05:20:43.762050Z",
            "last_modified": "2022-01-18T07:37:17.095015Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/6a46a311-9b3e-48bf-8d67-ef448df17147/?format=api",
            "uuid": "6a46a311-9b3e-48bf-8d67-ef448df17147",
            "name": "Inlaat A",
            "code": "KDU-Q-3520",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.697219846149037,
                    52.73381052450254,
                    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": 22048,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-12-13T05:57:09.473120Z",
            "last_modified": "2022-01-18T07:38:23.992458Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/900a3843-095f-479c-bbad-96e4236ea47b/?format=api",
            "uuid": "900a3843-095f-479c-bbad-96e4236ea47b",
            "name": "Inlaat Grote Sloot noord",
            "code": "KDU-Q-5262",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.742467332513849,
                    52.79445678702454,
                    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": 22032,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-12-13T05:57:09.582200Z",
            "last_modified": "2022-01-18T08:27:48.084187Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/1e563095-86dc-420d-b6a6-e67105b00795/?format=api",
            "uuid": "1e563095-86dc-420d-b6a6-e67105b00795",
            "name": "Inlaat Houtpolder / Meilag",
            "code": "KDU-Q-13304",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.245271313295168,
                    52.68328345487757,
                    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": 22058,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-12-13T05:57:09.791371Z",
            "last_modified": "2022-01-18T07:38:11.206000Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/02fdd154-cfda-4bdc-8c4f-20c789216cd6/?format=api",
            "uuid": "02fdd154-cfda-4bdc-8c4f-20c789216cd6",
            "name": "Inlaat Kolhorn",
            "code": "KDU-Q-1958",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.903734556576576,
                    52.79276797017617,
                    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": "2016-12-13T05:57:09.970315Z",
            "last_modified": "2022-01-18T07:38:48.368644Z",
            "last_modified_by": ""
        }
    ]
}