GetInfoViewImages

Class Description

Loads all InfoHeader images for a specific info header module Allowed File-Extensions are PNG an JPG

RPC Configuration

Rpc Name:

Plain: GetInfoViewImages
Sha1: f07abaaf063be3355a3361bdad9380421d2e3715

Rpc Call

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

Rpc Parameters:

"buildingId" : int,
"moduleId" : int 

Parameter Description

Gets the urls of the information view images for a specific module in a building. The response looks like this:

 {
  "headerImage": <url_header_image>,
  "squaredHeaderImage": <url_squared_header_image>
 }

@param int buildingId The id of the building.

@param int moduleId The id of the module.

@return array The array containing the images like this:

 {
  "headerImage": <url_header_image>,
  "squaredHeaderImage": <url_squared_header_image>
 }

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:

buildingId

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:

true

Cache Time to Live:

60