Parcel List
List assets of type Parcel
Query parameters:
organisation
Filter by organisation. Supports lookups on uuid
and name
.
code
Exact filter on the code
field. The (case-sensitive) startswith
lookup is also supported.
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.
geometry
The following lookups are available: isnull
, contained
, contains
,
contains_properly
, covered_by
, covers
, crosses
, disjoint
,
equals
, intersects
, overlaps
, and within
.
Query geometries can be supplied as WKT, EWKT or HEXEWKB.
boundary__id:
Filter on geometry of the region/boundary with the id boundary__id
.
For a list of regions/boundaries, see the boundary endpoint /api/v4/boundaries/
boundary__code:
Filter on geometry of the region/boundary with the id boundary__code
.
For a list of regions/boundaries, see the boundary endpoint /api/v4/boundaries/
boundary__type:
Spatial filter on geometry
, whereby geometry is specified by a
region/boundary object (see below) and filter operator is
ST_Intersects. Available types are COUNTRY, PROVINCE, WATER_BOARD,
MUNICIPALITY, CATCHMENT, POLDER, FIXED_DRAINAGE_LEVEL_AREA,
PUMPED_DRAINAGE_AREA, MAIN_PUMPED_DRAINAGE_AREA, DISTRICT,
NEIGHBOURHOOD, CADASTRE, PLANTATION, FIELD, CITY, and CUSTOM
boundary__name:
Filter on name of the region/boundary with the name
boundary__name
. Requires boundary__type
.
For a list of regions/boundaries, see the boundary endpoint /api/v4/boundaries/
simplify: Simplify the query geometries (in WGS84) using this value as tolerance. A higher value may result in a better response time for detailed geometries. Defaults to 0.00001 degrees (approx. 1 meter). NB: Returned geometries are unaffected.
page_size
The number of results on a single page. Defaults to 10, maximum is 100.
Note that pagination is disabled for the root endpoint: the response
will be truncated to page_size
.
Custom route: search
Full-text search in 'code' and 'name' fields. Results are ranked.
Examples:
?code=ABC_2123
?code__startswith=ABC
?created__gte=2017-01-01T00:00:00Z
?last_modified__lt=2018-01-01T00:00:00Z
?organisation__name__startswith=Nelen
?organisation__uuid=61f5a464-c350-44c1-9bc7-d4b42d7f58cb
?organisation__name__icontains=Schuur
?geometry__intersects=POINT (5 52)
?boundary__id=198
?boundary__code=NL_GM0344
?boundary__type=PROVINCE&boundary__name=Utrecht
/search/abc/
GET /api/v4/parcels/
{
"count": 0,
"next": null,
"previous": null,
"results": []
}