GetGalleriesByCampaign

Class Description

Accessing Galleries via Unified-Method Chaining, the galleries gallery_id is referenced by the key id only. e.g. Loading all Galleries of a Room and their contents

{
    "v": {{apiversion}},
    "strict": {{strict}},
    "apiKey": "{{apikey}}",
    "i18n": "{{i18n}}",
    "functions": "GetGalleriesByRoom,GetGalleriesByRoom",
    "1": {
        "room_id": <rid>,
        "building_id": <bid>,
    },
    "2": {
        "room_id": <rid>,
        "building_id": <bid>,
        "withContents": true,
        "gallery_id": "<font color="#d53035">GetGalleriesByRoom.0..id"</font> <- Here we have use id instead of gallery_id
    }

RPC Configuration

Rpc Name:

Plain: GetGalleriesByCampaign
Sha1: 540c7e1cc19223a14c4cf63b27e5652a56349051

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"campaign_id" : int,
"withContents" : bool = ,
"gallery_id" : ?int = null 

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,
    "campaign_id": 658,
    "withContents": true,
    "gallery_id": 15
}

<-

[
    {
        "gallery_id": 15
    }
]