Zum Hauptinhalt springen

LoadImageBundle

RPC Configuration​

Rpc Name:​

Plain: LoadImageBundle
Sha1: 99e9c6c675ff4e642642c34bfe8c6d9c68dedec9
Rpc Call

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

Rpc Parameters:​

"building_id" : int,
"expires" : int = 0,
"responseFileName" : string = blkimages.zip
Parameter Description

Loads all Category and Room Images of a Guide into a Zipfile and returns as a buffer attachment to be downloaded by a client.

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.

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

Sample Request​

->

[]