GetEntitiesOfGallery

Class Description

RPC Configuration

Rpc Name:

Plain: GetEntitiesOfGallery
Sha1: 091e8c83241bbf6b4c88ce407a4fb3af77c70572

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"gallery_id" : int 

Parameter Description

Loads all Entity-Descriptions of the requested Gallery.
@return Array[EntityOfGallery]

[
    {
        "id": int,
        "title": string,
        "description": string,
        "entity_id": int,
        "entity_name":  string,
        "entity_type": "room"|"campaign"
    }
]

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.

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

Sample Request

->

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

<-

false