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

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=9",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=7",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/152b535f-9ea6-4a4d-bc19-43b7f103daff/?format=api",
            "uuid": "152b535f-9ea6-4a4d-bc19-43b7f103daff",
            "name": "Inlaat Kolping Boys",
            "code": "KDU-Q-723",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.777515167300978,
                    52.63986869600731,
                    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": "2016-12-13T05:57:10.085359Z",
            "last_modified": "2022-01-18T08:27:27.414403Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ee34dbf3-c15c-46b2-9d88-254c40d2adbf/?format=api",
            "uuid": "ee34dbf3-c15c-46b2-9d88-254c40d2adbf",
            "name": "Inlaat Oostzaan",
            "code": "KDU-Q-28114",
            "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": 22062,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-12-13T05:57:10.515144Z",
            "last_modified": "2022-01-18T07:39:05.178997Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/fc48245d-4147-40f9-9545-cc07bd5e4fa5/?format=api",
            "uuid": "fc48245d-4147-40f9-9545-cc07bd5e4fa5",
            "name": "Inlaat/uitlaat schuif Rijweg",
            "code": "KDU-Q-12472",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.08538505326236,
                    52.68577391299688,
                    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": "2016-12-13T05:57:10.718048Z",
            "last_modified": "2022-01-18T07:39:09.542732Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/cbbae004-15f0-4e73-8195-6c0529452582/?format=api",
            "uuid": "cbbae004-15f0-4e73-8195-6c0529452582",
            "name": "Inlaat Veenhuizerpolder",
            "code": "KDU-Q-696",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.88556601125482,
                    52.70961830356123,
                    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": 22036,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2016-12-13T05:57:10.798852Z",
            "last_modified": "2022-01-18T07:38:41.066190Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/2e825d03-c58a-4941-b410-65f30480ed5d/?format=api",
            "uuid": "2e825d03-c58a-4941-b410-65f30480ed5d",
            "name": "Inlaat Waardweg, Benedenpeil 1",
            "code": "KDU-Q-2348_benedenpeil_1",
            "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-12-28T17:03:43.965541Z",
            "last_modified": "2022-01-18T07:35:20.634421Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/06f680d7-86eb-47c1-b6af-3e4f304b60c8/?format=api",
            "uuid": "06f680d7-86eb-47c1-b6af-3e4f304b60c8",
            "name": "Inlaat Waardweg, Instroompeil",
            "code": "KDU-Q-2348_instroompeil",
            "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-12-28T17:03:44.636397Z",
            "last_modified": "2022-01-18T07:39:24.141844Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/28ae2b6f-6c95-4518-87f0-5659ea50e0e0/?format=api",
            "uuid": "28ae2b6f-6c95-4518-87f0-5659ea50e0e0",
            "name": "Inlaat Monnickendam / De Nieuwendam, Inlaat debiet fews",
            "code": "KDU-B-848_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.034302036719975,
                    52.46372783195455,
                    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": 316,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2017-04-13T12:26:41.552762Z",
            "last_modified": "2022-01-18T08:26:38.046866Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/20597472-aefa-463a-bf8a-54d6caab3057/?format=api",
            "uuid": "20597472-aefa-463a-bf8a-54d6caab3057",
            "name": "Inlaat Monnickendam / De Nieuwendam, Spui debiet fews",
            "code": "KDU-B-848_spui_debiet_fews",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.034302036719975,
                    52.46372783195455,
                    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": 316,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2017-04-13T12:26:41.600197Z",
            "last_modified": "2022-01-18T07:54:56.461636Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/56ac4305-ae96-4e91-bf7c-25b6bcc97b44/?format=api",
            "uuid": "56ac4305-ae96-4e91-bf7c-25b6bcc97b44",
            "name": "Inlaat Monnickendam / De Nieuwendam, Sluis debiet fews",
            "code": "KDU-B-848_sluis_debiet_fews",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.034302036719975,
                    52.46372783195455,
                    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": 316,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2017-04-13T12:26:41.640871Z",
            "last_modified": "2022-01-18T08:19:42.257522Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/edbf83c0-2752-4f8c-922f-307fc18df85a/?format=api",
            "uuid": "edbf83c0-2752-4f8c-922f-307fc18df85a",
            "name": "Inlaat Oudesluis, Geleidbaarheid ( EGV bij 25 oC)",
            "code": "KDU-Q-2025_geleidbaarheid_(_egv_bij_25_oc)",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.812127204243386,
                    52.83242872277419,
                    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": 14924,
                "type": "culvert"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2017-07-19T09:23:32.809939Z",
            "last_modified": "2022-01-18T07:38:49.968010Z",
            "last_modified_by": ""
        }
    ]
}