Location Instance – Django REST framework

Endpoint for interacting with locations.

Query parameters

created: Temporal filter on created. Supports created__icontains, created__iexact, created__gte, created__gt, created__lt, created__lte, created__startswith. (created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

dist: Spatial filter on geometry. Also requires a point in (lon, lat) format. Distances, in meters, are internally converted to degrees. This conversion is approximate (and worse for high latitudes).

geom_isnull: Boolean filter on geometry.

geom_within: Spatial filter on geometry. Supports WKT, HEXEWKB, and GeoJSON.

in_bbox: Spatial filter on geometry. The bounding box format is: min Lat, min Lon, max Lat, max Lon. Includes locations that overlap the bounding box.

locationName: Text filter on name. Supports locationName__icontains, locationName__startswith lookup types(name__exact by default).

locationCode: Text filter on code. Supports locationCode__icontains, locationCode__startswith lookup types (locationCode__exact by default).

object_id: Number filter on the id attribute of an object. Supports object_id__icontains, object_id__startswith lookup types (object_id__exact by default). To be used in combination with object_type.

object_type: Related filter on object. See below for an example on how to filter on assets like sluices, pump stations, etc.

ordering: Offers basic ordering functionality on the name attribute of locations. Orderings may be reversed by prefixing the attribute with '-'.

organisation: Related filter on organisation. See the organisations endpoint.

organisation_code (or just code for short): Text filter on code. Supports organisation_code__icontains, organisation_code__exact, organisation_code__startswith lookup types (organisation_code__exact by default).

page: To prevent system overloads, list-view results are paginated. This parameter specifies which page to return.

pageSize: The maximum number of results to return in list-view. The default is 10.

point: See dist.

locationId: Text filter on uuid. Supports a comma-separated list of (fragments of) UUIDs. Supports locationId__icontains and locationId__iexact as default.

Examples

?created__gte=2017-01-01T00:00:00Z

?dist=1000&point=4.87,52.73

?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]]]}

?in_bbox=4.86,52.73,4.98,52.79

?locationName__icontains=gemaal

?object_type__model=sluice

?object_type__model=pumpstation&object_id=1

?ordering=name

?organisation__name=Noorderzijlvest

?organisation_code__startswith=WNS1400

?locationId__icontains=67035326-c5e3-41d2-ba7a-0bd4b8626b29

GET /dd/api/v2/locations/572d4222-d878-4463-ad20-9e1320cd5942/?format=api

HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": "572d4222-d878-4463-ad20-9e1320cd5942",
    "type": "Feature",
    "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
            [
                [
                    [
                        5.069714938270513,
                        52.71202186925913,
                        0.0
                    ],
                    [
                        5.069669034823524,
                        52.71243955805241,
                        0.0
                    ],
                    [
                        5.070998596562866,
                        52.71274481402424,
                        0.0
                    ],
                    [
                        5.071043264973903,
                        52.7127580535375,
                        0.0
                    ],
                    [
                        5.072017589844494,
                        52.71304677105808,
                        0.0
                    ],
                    [
                        5.072985888540834,
                        52.71344115985078,
                        0.0
                    ],
                    [
                        5.07397740228792,
                        52.71387166627274,
                        0.0
                    ],
                    [
                        5.074090316509992,
                        52.71350797493299,
                        0.0
                    ],
                    [
                        5.074597270174301,
                        52.71358730431498,
                        0.0
                    ],
                    [
                        5.074688790190996,
                        52.71341149972517,
                        0.0
                    ],
                    [
                        5.074320536442912,
                        52.71336191348145,
                        0.0
                    ],
                    [
                        5.074386884167027,
                        52.71270428998415,
                        0.0
                    ],
                    [
                        5.073510191338158,
                        52.71262841679775,
                        0.0
                    ],
                    [
                        5.072944539594088,
                        52.71253159207272,
                        0.0
                    ],
                    [
                        5.072598930416231,
                        52.71252201609828,
                        0.0
                    ],
                    [
                        5.072257381673695,
                        52.71254879298224,
                        0.0
                    ],
                    [
                        5.07231544532124,
                        52.71209515175449,
                        0.0
                    ],
                    [
                        5.069714938270513,
                        52.71202186925913,
                        0.0
                    ]
                ]
            ]
        ]
    },
    "properties": {
        "url": "https://demo.lizard.net/dd/api/v2/locations/572d4222-d878-4463-ad20-9e1320cd5942/?format=api",
        "locationCode": "6750O-18",
        "locationName": "6750O-18",
        "node": {
            "url": "https://demo.lizard.net/dd/api/v2/nodes/6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5/?format=api",
            "uuid": "6be7b0dd-b65b-4e33-adcc-80ef1e28b4b5",
            "name": "Lizard",
            "description": "",
            "baseUrl": ""
        }
    }
}