ModifyQuickDestination

Class Description

Quickdestinations are Destinations that are linked to a contagt-id (tag) and have another contagt-id as their destination. Apps can use this to offer fast routing suggestions at certain locations.

RPC Configuration

Rpc Name:

Plain: ModifyQuickDestination
Sha1: f2bcf21219c62df5558d194ca6f3b9d13b4b7fd3

Rpc Call

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

Rpc Parameters:

"tag" : string,
"method" : string,
"target" : ?string = null 

Parameter Description

@param string tag The contagt-id that is supposed to be the routing destination.

@param string method Can be 'add' or 'remove'.

@param ?string target If left empty (or null, its default value) the guides root-tag will be autoselected, otherwise it is bound to the given contagt-id.

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:

tag

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

->

{
    "tag": "njMqjt4a",
    "method": "add",
    "target": "5dQg3abu"
}

<-

true