DeleteRoomContent

Class Description

Deletes a Content Type by Type or Id. If the Type is one of the Non-Unique Content Types, the request will be ignored, if ignoreUnique is not explicitly set to true.

RPC Configuration

Rpc Name:

Plain: DeleteRoomContent
Sha1: ee582e39dd6583783c105114839973eb5768ba67

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"room_id" : int,
"typeOrId" : string|int,
"ignoreUnique" : bool =  

Parameter Description

@param int building_id Transmitted for context control!

@param int room_id The room ID to delete on

@param string|int typeOrId The content fields Id or the Content Type. The request will be ignored, if ignoreUnique is not explicitly set to true and typeOrId is a non-unique content type.

@param bool ignoreUnique Ignore the unique constraint and delete all elements with the give Content Type

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

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.

LOCAL_ADMINISTRATOR

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,
    "room_id": 7933,
    "type": "owner"
}

<-

true