Building Instance

List assets of type Building.

Query parameters

id: Numerical filter on the id field.

code: Text filter on the code field. All text field filter methods, like startswith, endswith, icontains are 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.

organisation Filter by organisation. Supports lookups on uuid and name.

build_year: Numerical filter on the build_year field. All numeric field filter methods are supported: gt, gte, lt, lte, and isnull.

start/end: Both query parameters can be used to filter the buildings. They define an interval [start, end) and should be either in ISO 8601 YYYY-MM-DDThh:mm:ssZ format or in milliseconds since the epoch. Available lookups are gt, gte, lt, lte, isnull.

valid_at: Return only buildings that are present at given timestamp. If multiple buildings with the same code and organisation are present, only the one with the latest start is returned.

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

geom_intersects: Spatial filter on geometry, filter operator is ST_intersects. 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 assets that overlap the bounding box.

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.

addresses__postalcode: Filter on postal code of the building address(es). All text field filter methods, in particular startswith, endswith, contains are supported, e. g. postalcode__startswith=9 returns buildings within the postal code area 9.

addresses__house_number: Filter on house number of building address(es).

addresses__house_letter: Filter on house letter of building address(es).

addresses__house_number_suffix: Filter on house number suffix of building address(es).

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: by-organisation

Filter assets by organisation UUID. Pagination is enabled on this endpoint. /api/v4/buildings/by-organisation//

Examples

?id=1

?code=135123

?code__startswith=0100

?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

?build_year__gt=1997

?start__gt=1900-01-01T00:00:00Z

?start=2019-01-01T02:03:04Z

?start__gt=1900-01-01T00:00:00Z&end__lt=2000-01-01T00:00:00Z

?start__gt=2015-01-01T00:00:00Z&end__isnull=true

?valid_at=2010-01-01T00:00:00Z

?geom_within=POLYGON((4.87 52.73, 4.87 52.79, 4.98 52.79,
4.98 52.73, 4.87 52.73))

?geom_intersects=POLYGON((4.87 52.73, 4.87 52.79, 4.98 52.79,
4.98 52.73, 4.87 52.73))

?in_bbox=4.8,52.7,4.9,52.8

?boundary__id=198

?boundary__code=NL_GM0344

?boundary__type=PROVINCE&boundary__name=Utrecht

?addresses__postalcode=1111AA

?addresses__postalcode=1111AA&addresses__house_number__gte=1&addresses__house_number__lte=99

?addresses__postalcode__startswith=1

?page_size=20

/by-organisation/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/