RequestLockshare

Class Description

Request a LockShare for Write-Access on a Guide. The current Editor will receive a request and can approve or deny it. If approved, the requesting user can also edit the guide. Be careful with lost updates! This request is Realtime Exclusive.

RPC Configuration

Rpc Name:

Plain: RequestLockshare
Sha1: e9054404d07f50431c0f46bc40b916ffe5c96144

Rpc Call

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

Rpc Parameters:

"building_id" : int 

Parameter Description

This interface should be called via the Realtime API.

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:

false

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.

false

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.

STANDARD_USER

Requires Subbuilding Merge Strategy:

REPLACE

Cache Configuration

Response Cache

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

Cache enabled:

false

Realtime API

This RPC is applicable to the Realtime API. You can subscribe to events that reflect in a response to your request.

Sample Request

->

{
    "building_id": 131
}

<-

{
    "building_id": 131,
    "user_id": 1
}