SetCampaignEnabled

Class Description

Hard enable or disable a campaign without having to change any of the campaigns definition data.

RPC Configuration

Rpc Name:

Plain: SetCampaignEnabled
Sha1: 2fdf569c2084745b2c88d43d4dd56b2ca7b41708

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"campaign_id" : int = -1,
"isenabled" : mixed = 1 

Parameter Description

Building ID is transmitted for context control!
@param int building_id

@param int campaign_id

@param bool isenabled

@return array|bool

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.

true

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.

LOCAL_ADMINISTRATOR

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

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

->

{
    "building_id": 131,
    "campaign_id": 115,
    "isenabled": true
}

<-

{
    "id": 115,
    "name": {
        "de_DE": null,
        "en_EN": null
    },
    "enabled": 0,
    "categories": [],
    "config": null,
    "content_type": null,
    "content": {
        "de_DE": "",
        "en_EN": null
    },
    "handle": "campaign_0a91a92da4cfaa2a0c48707d97c38d24996418e9",
    "image": null,
    "audio_uri": [],
    "panorama_uri": false,
    "source_image_uri": false,
    "date_start": null,
    "date_end": null,
    "created_on": null,
    "constraints": [],
    "teaser": {
        "de_DE": null,
        "en_EN": null
    },
    "campaign_type": [],
    "accessibleOnly": false,
    "withUnresolvableConstraints": true
}