DeleteAllRooms

Class Description

Method requires user to be of Type AuthorizationLevel::SUPERUSER Will delete all Rooms of a Building on the given Floor. If unconnectedOnly is set to true, only rooms without a Tag reference will be deleted. Four more Parameters are available to define a Bounding Box. Only Rooms contained within that Bounds will be deleted. If any of the BBox Parameters is null, all will be ignored.
@param ?float minLat

@param ?float minLon

@param ?float maxLat

@param ?float maxLon Optional Boundingbox

RPC Configuration

Rpc Name:

Plain: DeleteAllRooms
Sha1: 2d527f332c2ecf49555cee8fbc4fb138326980cf

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:

"building_id" : int,
"floor" : int,
"unconnectedOnly" : bool = ,
"minLat" : ?float = null,
"minLon" : ?float = null,
"maxLat" : ?float = null,
"maxLon" : ?float = null 

Requires Login:

true

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

true

Requires contextParamName:

building_id

Has Named Parameters:

true

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

true

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

SUPERUSER

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Sample Request

->

{
    "building_id": 131
}