Zum Hauptinhalt springen

LoadSettingsForUser

Class Description

Loads all User specific Building Settings for any User. Method requires calling user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: LoadSettingsForUser
Sha1: a39a7ddb523c7a5838efdc15c637b0c4b27a4c91
Rpc Call

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

Rpc Parameters:

"building_id" : int,
"user_id" : int

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.

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,
"user_id": 1
}

<-

{
"terminal_startlocation": null,
"terminal_rotation": null,
"terminal_landingpage": null,
"terminal_screensaver": null,
"terminal_embedded": null,
"terminal_hideCategories": null,
"terminal_hideRooms": null,
"terminal_hasKeyboard": null,
"terminal_startmode": null,
"terminal_mainFontSize": null,
"terminal_secondaryFontSize": null,
"terminal_iconSize": null
}