GET

Location List

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=15
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=16",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=14",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/9181dbc8-92bb-432c-9302-067ba83dce99/?format=api",
            "uuid": "9181dbc8-92bb-432c-9302-067ba83dce99",
            "name": "Inlaat Waterloopbos, hoofdmeter, inkoop",
            "code": "A31815247-HFD/Ap",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.856930239403225,
                    52.75087092533737,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23056,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-24T09:07:50.797815Z",
            "last_modified": "2022-01-18T03:39:19.022278Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/42845f5c-77ca-4e5f-a6c0-d47a0d895078/?format=api",
            "uuid": "42845f5c-77ca-4e5f-a6c0-d47a0d895078",
            "name": "Inlaat Blokzijl, hoofdmeter, inkoop",
            "code": "A06313372-HFD/Ap",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.956957493534111,
                    52.72476592084973,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23055,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-24T09:07:50.797969Z",
            "last_modified": "2022-01-18T03:42:36.187091Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/9224ce34-674e-4a5a-8780-95af6386a862/?format=api",
            "uuid": "9224ce34-674e-4a5a-8780-95af6386a862",
            "name": "Inlaat Ramspol, hoofdmeter, inkoop",
            "code": "A16032317-HFD/Ap",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.851221195653575,
                    52.61601299861483,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23054,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-24T09:07:50.798147Z",
            "last_modified": "2022-01-18T03:33:26.535399Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/070e0086-8a44-45d9-bbaa-5889d00172ce/?format=api",
            "uuid": "070e0086-8a44-45d9-bbaa-5889d00172ce",
            "name": "Inlaat Kanaalweg, hoofdmeter, inkoop",
            "code": "A07260828-HFD/Ap",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.9515043090712,
                    52.71197673803914,
                    0.0
                ]
            },
            "organisation": {
                "url": "https://demo.lizard.net/api/v4/organisations/188a569b-f0ac-4e98-81db-499de07f7582/?format=api",
                "uuid": "188a569b-f0ac-4e98-81db-499de07f7582",
                "name": "Zuiderzeeland"
            },
            "object": {
                "id": 23053,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-06-24T09:07:50.798299Z",
            "last_modified": "2022-01-18T03:27:16.667815Z",
            "last_modified_by": "emile.debadts"
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/a0ece4a5-27db-4f8f-8bce-bb81448d997e/?format=api",
            "uuid": "a0ece4a5-27db-4f8f-8bce-bb81448d997e",
            "name": "Inlaat Nulpsloot, Stand inlaat 1",
            "code": "KDU-Q-32628_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.913588046313937,
                    52.72158936048773,
                    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": 22028,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.232878Z",
            "last_modified": "2022-01-18T07:35:29.093257Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/6d04c745-4203-4c5d-a848-4881be3f7e81/?format=api",
            "uuid": "6d04c745-4203-4c5d-a848-4881be3f7e81",
            "name": "Inlaat Kadijk (waterberging), Stand aflaat",
            "code": "KDU-A-3946_stand_aflaat",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.203563446304744,
                    52.71019229369565,
                    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": 22085,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.234216Z",
            "last_modified": "2022-01-18T07:38:07.883373Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/52949a29-20e3-4923-9bb1-c406ea03ea1d/?format=api",
            "uuid": "52949a29-20e3-4923-9bb1-c406ea03ea1d",
            "name": "Inlaat Kadijk (waterberging), Stand inlaat",
            "code": "KDU-A-3946_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.203563446304744,
                    52.71019229369565,
                    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": 22085,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.234402Z",
            "last_modified": "2022-01-18T08:06:10.017631Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/e690087a-639c-4b74-a880-2c6d5604d46c/?format=api",
            "uuid": "e690087a-639c-4b74-a880-2c6d5604d46c",
            "name": "Inlaat A, Stand inlaat",
            "code": "KDU-Q-3520_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.697186862059199,
                    52.733706621123396,
                    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": "2020-07-16T13:15:01.234804Z",
            "last_modified": "2022-01-18T08:21:07.574167Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/b778bbe4-c8d3-4f0a-8a74-800816b4895d/?format=api",
            "uuid": "b778bbe4-c8d3-4f0a-8a74-800816b4895d",
            "name": "Inlaat Wijdenes, Stand inlaat 2",
            "code": "KDU-Q-11880_stand_inlaat_2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.171122139106935,
                    52.63139340696514,
                    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": 22054,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.235171Z",
            "last_modified": "2022-01-18T07:38:43.056483Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/619c7a67-7cfa-416e-8a34-b8848e10d198/?format=api",
            "uuid": "619c7a67-7cfa-416e-8a34-b8848e10d198",
            "name": "Inlaat Wijdenes, Stand inlaat 1",
            "code": "KDU-Q-11880_stand_inlaat_1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    5.171122139106935,
                    52.63139340696514,
                    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": 22054,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.235366Z",
            "last_modified": "2022-01-18T07:38:36.392691Z",
            "last_modified_by": ""
        }
    ]
}