LoadCampaigns

Class Description

Loads all Campaings, optionally filtered by a Beacon Id.

RPC Configuration

Rpc Name:

Plain: LoadCampaigns
Sha1: c27752cc353f15f862c96d9b48928b6892bb2fc5

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"beacon_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
}

<-

[
    {
        "id": 659,
        "name": {
            "de_DE": "Test Info",
            "en_EN": null
        },
        "enabled": 1,
        "categories": [],
        "config": {
            "cooldown_enter": 10000,
            "cooldown_exit": 10000
        },
        "content_type": "AUDIO",
        "content": {
            "de_DE": "Und ich bin der Text",
            "en_EN": null
        },
        "handle": "campaign_4effa2462243bce076467bf32844ec0c3f714ee6",
        "image": null,
        "audio_uri": [],
        "panorama_uri": false,
        "source_image_uri": false,
        "date_start": "2023-11-23 08:47:00",
        "date_end": "0000-00-00 00:00:00",
        "created_on": "2023-11-23 08:47:52",
        "constraints": [],
        "teaser": {
            "de_DE": "Ich bin der Teaser",
            "en_EN": null
        },
        "campaign_type": [
            "INFO"
        ],
        "accessibleOnly": false,
        "withUnresolvableConstraints": true
    }
]