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

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=18",
    "previous": "https://demo.lizard.net/api/v4/locations/?format=api&name__startswith=Inlaat&page=16",
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/locations/f1761c13-6891-45b5-96bd-ef9375878120/?format=api",
            "uuid": "f1761c13-6891-45b5-96bd-ef9375878120",
            "name": "Inlaat grote Sloot zuid, Stand inlaat",
            "code": "KDU-Q-5717_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.73114154883528,
                    52.78409940841585,
                    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": 22024,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.237727Z",
            "last_modified": "2022-01-18T08:12:54.938492Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/79df7a51-71c3-45be-9d2b-63cb35d71d13/?format=api",
            "uuid": "79df7a51-71c3-45be-9d2b-63cb35d71d13",
            "name": "Inlaat Monnickendam / De Nieuwendam, Stand rinket",
            "code": "KDU-B-848_rinket_laag",
            "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": 22027,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.238499Z",
            "last_modified": "2022-01-18T08:19:24.045458Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/d47203f7-9189-427e-aca3-adc31b127f10/?format=api",
            "uuid": "d47203f7-9189-427e-aca3-adc31b127f10",
            "name": "Inlaat Monnickendam / De Nieuwendam, Stand rinket",
            "code": "KDU-B-848_rinket_hoog",
            "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": 22027,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.238681Z",
            "last_modified": "2022-01-18T07:54:17.295898Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/5213b19d-6974-4095-a901-801c03a1a47b/?format=api",
            "uuid": "5213b19d-6974-4095-a901-801c03a1a47b",
            "name": "Inlaat Aurora, Stand inlaat 1",
            "code": "KDU-Q-32931_schuif1",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.940421183063775,
                    52.70102561133926,
                    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": 22030,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.238862Z",
            "last_modified": "2022-01-18T07:38:56.682829Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/25779199-42d7-48e5-91bb-78947df2404b/?format=api",
            "uuid": "25779199-42d7-48e5-91bb-78947df2404b",
            "name": "Inlaat Aurora, Stand inlaat 2",
            "code": "KDU-Q-32931_schuif2",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.940421183063775,
                    52.70102561133926,
                    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": 22030,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.239041Z",
            "last_modified": "2022-01-18T07:38:44.171604Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/3302bd5d-bcc2-4f07-a7e7-cf2b9c394067/?format=api",
            "uuid": "3302bd5d-bcc2-4f07-a7e7-cf2b9c394067",
            "name": "Inlaat Grote Sloot noord, Stand inlaat",
            "code": "KDU-Q-5262_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.742465323909685,
                    52.79445737006159,
                    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": "2020-07-16T13:15:01.239402Z",
            "last_modified": "2022-01-18T07:56:25.440044Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/54cd0d1c-04c8-4cfe-bebc-1ce15b31380a/?format=api",
            "uuid": "54cd0d1c-04c8-4cfe-bebc-1ce15b31380a",
            "name": "Inlaat Spanbroek, Stand inlaat",
            "code": "KDU-N-1000_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.942377838022352,
                    52.69818731883943,
                    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": 22034,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.239581Z",
            "last_modified": "2022-01-18T08:20:34.551583Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/cc462689-9248-412c-a416-d6781bcc3421/?format=api",
            "uuid": "cc462689-9248-412c-a416-d6781bcc3421",
            "name": "Inlaat Veenhuizerpolder, Stand inlaat",
            "code": "KDU-Q-696_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.885553995524956,
                    52.70977177493336,
                    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": "2020-07-16T13:15:01.239780Z",
            "last_modified": "2022-01-18T07:38:26.522733Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/ea3f9676-6821-42e8-93fe-bdb151f7b9e3/?format=api",
            "uuid": "ea3f9676-6821-42e8-93fe-bdb151f7b9e3",
            "name": "Inlaat Hensbroek, Stand inlaat",
            "code": "KDU-Q-13384_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.869384830933738,
                    52.64681840633382,
                    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": 22037,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.239966Z",
            "last_modified": "2022-01-18T08:28:20.135219Z",
            "last_modified_by": ""
        },
        {
            "url": "https://demo.lizard.net/api/v4/locations/fd188a3a-fcc7-40dc-b4b8-3dcfc5a57b0c/?format=api",
            "uuid": "fd188a3a-fcc7-40dc-b4b8-3dcfc5a57b0c",
            "name": "Inlaat Ursem, Stand inlaat",
            "code": "KDU-Q-11372_schuif",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    4.884008968290925,
                    52.63263584466134,
                    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": 22038,
                "type": "weir"
            },
            "access_modifier": "Public",
            "extra_metadata": {},
            "created": "2020-07-16T13:15:01.240159Z",
            "last_modified": "2022-01-18T08:00:05.089186Z",
            "last_modified_by": ""
        }
    ]
}