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/2ad97c6d-23d4-43d0-95f9-5a9f495480b6/?format=api

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

{
    "id": "2ad97c6d-23d4-43d0-95f9-5a9f495480b6",
    "type": "Feature",
    "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
            [
                [
                    [
                        5.00860200928277,
                        52.7514285173755,
                        0.0
                    ],
                    [
                        5.008573966375294,
                        52.75089209232569,
                        0.0
                    ],
                    [
                        5.00857273244843,
                        52.75086860573177,
                        0.0
                    ],
                    [
                        5.007695213022473,
                        52.75080097359091,
                        0.0
                    ],
                    [
                        5.007695186433829,
                        52.75080062301854,
                        0.0
                    ],
                    [
                        5.007603200323672,
                        52.74976641815819,
                        0.0
                    ],
                    [
                        5.007466735209122,
                        52.74977001838849,
                        0.0
                    ],
                    [
                        5.007319738412946,
                        52.74977378259369,
                        0.0
                    ],
                    [
                        5.007207456938128,
                        52.7483431016243,
                        0.0
                    ],
                    [
                        5.005581813297882,
                        52.74775535856755,
                        0.0
                    ],
                    [
                        5.005357446914742,
                        52.74769900194326,
                        0.0
                    ],
                    [
                        5.004730029334579,
                        52.74759390993896,
                        0.0
                    ],
                    [
                        5.003186313644096,
                        52.74748833600378,
                        0.0
                    ],
                    [
                        5.002303925432813,
                        52.74740528964497,
                        0.0
                    ],
                    [
                        5.000991291648222,
                        52.74739786027315,
                        0.0
                    ],
                    [
                        4.998093748720888,
                        52.74738142209813,
                        0.0
                    ],
                    [
                        4.996872194992615,
                        52.74734242223192,
                        0.0
                    ],
                    [
                        4.996169582286517,
                        52.74735721118662,
                        0.0
                    ],
                    [
                        4.995609746924613,
                        52.74741205257918,
                        0.0
                    ],
                    [
                        4.995112472726383,
                        52.74748274340869,
                        0.0
                    ],
                    [
                        4.993521975208195,
                        52.74768189579671,
                        0.0
                    ],
                    [
                        4.992823489903932,
                        52.74770797516723,
                        0.0
                    ],
                    [
                        4.992092938850602,
                        52.74775726504982,
                        0.0
                    ],
                    [
                        4.991320479282331,
                        52.74776498169289,
                        0.0
                    ],
                    [
                        4.990115833894771,
                        52.74790915725539,
                        0.0
                    ],
                    [
                        4.989850191030569,
                        52.74794007611705,
                        0.0
                    ],
                    [
                        4.989564541850807,
                        52.74797565471166,
                        0.0
                    ],
                    [
                        4.989281135732687,
                        52.7479924755113,
                        0.0
                    ],
                    [
                        4.988725487098236,
                        52.74792529268579,
                        0.0
                    ],
                    [
                        4.988235135404357,
                        52.74778822829033,
                        0.0
                    ],
                    [
                        4.988404850279553,
                        52.74975517918677,
                        0.0
                    ],
                    [
                        4.988471765041922,
                        52.7514121331919,
                        0.0
                    ],
                    [
                        4.98817577503891,
                        52.75141934725343,
                        0.0
                    ],
                    [
                        4.987310588957496,
                        52.75144042343246,
                        0.0
                    ],
                    [
                        4.987026094548907,
                        52.75144734969368,
                        0.0
                    ],
                    [
                        4.984705861618576,
                        52.75144508773808,
                        0.0
                    ],
                    [
                        4.984128635220024,
                        52.75148812458116,
                        0.0
                    ],
                    [
                        4.984020354990241,
                        52.74976841622844,
                        0.0
                    ],
                    [
                        4.983839764467778,
                        52.74976910804332,
                        0.0
                    ],
                    [
                        4.983174426973114,
                        52.74978427014259,
                        0.0
                    ],
                    [
                        4.983202150008946,
                        52.75021709126585,
                        0.0
                    ],
                    [
                        4.982958493477762,
                        52.75022426309847,
                        0.0
                    ],
                    [
                        4.982470143053606,
                        52.7502386466791,
                        0.0
                    ],
                    [
                        4.982557567060818,
                        52.7511750255871,
                        0.0
                    ],
                    [
                        4.982568147699367,
                        52.75128841296854,
                        0.0
                    ],
                    [
                        4.981326361411202,
                        52.75131754834442,
                        0.0
                    ],
                    [
                        4.980788712112351,
                        52.75133619661679,
                        0.0
                    ],
                    [
                        4.980793615844894,
                        52.75144955581001,
                        0.0
                    ],
                    [
                        4.980800814744008,
                        52.7516173293662,
                        0.0
                    ],
                    [
                        4.980781392492103,
                        52.75169458617978,
                        0.0
                    ],
                    [
                        4.979172509417539,
                        52.75172262604158,
                        0.0
                    ],
                    [
                        4.978031491580373,
                        52.75177629178659,
                        0.0
                    ],
                    [
                        4.976607840250614,
                        52.75177180738932,
                        0.0
                    ],
                    [
                        4.976103239725004,
                        52.75178909254197,
                        0.0
                    ],
                    [
                        4.975486851872627,
                        52.75187181817734,
                        0.0
                    ],
                    [
                        4.974794746812575,
                        52.75181748031881,
                        0.0
                    ],
                    [
                        4.974434685425406,
                        52.75181450794047,
                        0.0
                    ],
                    [
                        4.974238689346572,
                        52.75020825990434,
                        0.0
                    ],
                    [
                        4.974384597716807,
                        52.75019945516325,
                        0.0
                    ],
                    [
                        4.974537710422632,
                        52.75024034568744,
                        0.0
                    ],
                    [
                        4.975400830629787,
                        52.75013777229632,
                        0.0
                    ],
                    [
                        4.975341864824913,
                        52.74960511373419,
                        0.0
                    ],
                    [
                        4.974238073921438,
                        52.74974818336435,
                        0.0
                    ],
                    [
                        4.97394576985574,
                        52.74980053389911,
                        0.0
                    ],
                    [
                        4.97360872158498,
                        52.74990796176949,
                        0.0
                    ],
                    [
                        4.97312193924636,
                        52.75009043904667,
                        0.0
                    ],
                    [
                        4.972956259016647,
                        52.75015254658529,
                        0.0
                    ],
                    [
                        4.972791688111519,
                        52.75029471289258,
                        0.0
                    ],
                    [
                        4.972760338183803,
                        52.75037420963526,
                        0.0
                    ],
                    [
                        4.972413280136441,
                        52.75125435417497,
                        0.0
                    ],
                    [
                        4.972293789057329,
                        52.7516015415959,
                        0.0
                    ],
                    [
                        4.972076536022708,
                        52.75238285886376,
                        0.0
                    ],
                    [
                        4.972102189873609,
                        52.75259564964241,
                        0.0
                    ],
                    [
                        4.97406737912529,
                        52.75250840566871,
                        0.0
                    ],
                    [
                        4.974956615668582,
                        52.75247332756826,
                        0.0
                    ],
                    [
                        4.97580087151728,
                        52.75244898859991,
                        0.0
                    ],
                    [
                        4.97786197810926,
                        52.75240158241466,
                        0.0
                    ],
                    [
                        4.979631276296759,
                        52.75235314269074,
                        0.0
                    ],
                    [
                        4.981970916541338,
                        52.75228481576237,
                        0.0
                    ],
                    [
                        4.983695213673868,
                        52.75224706369259,
                        0.0
                    ],
                    [
                        4.988468412231609,
                        52.7521459448585,
                        0.0
                    ],
                    [
                        4.99127505682848,
                        52.75206264109868,
                        0.0
                    ],
                    [
                        4.996354527678844,
                        52.75184503492866,
                        0.0
                    ],
                    [
                        4.998685381681613,
                        52.7517490937712,
                        0.0
                    ],
                    [
                        4.999906754167672,
                        52.75172036707981,
                        0.0
                    ],
                    [
                        5.002255257492556,
                        52.75165711665282,
                        0.0
                    ],
                    [
                        5.00722665948788,
                        52.7514659549264,
                        0.0
                    ],
                    [
                        5.008439075764907,
                        52.75143165717144,
                        0.0
                    ],
                    [
                        5.00860200928277,
                        52.7514285173755,
                        0.0
                    ]
                ]
            ]
        ]
    },
    "properties": {
        "url": "https://demo.lizard.net/dd/api/v2/locations/2ad97c6d-23d4-43d0-95f9-5a9f495480b6/?format=api",
        "locationCode": "6750T-15",
        "locationName": "6750T-15",
        "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": ""
        }
    }
}