CheckLinkusage

Class Description

Verifies if an activation link was yet clicked. If so, a usertoken will be returned.

RPC Configuration

Rpc Name:

Plain: CheckLinkusage
Sha1: b2b5ae9aea1c10bbf0ef37691cd32fe441dea63a

Rpc Call

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

Rpc Parameters:

"account_id" : int,
"sharedSecret" : string,
"longpoll" : 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.

false

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:

false

Sample Request

->

{
    "account_id": 1,
    "sharedSecret": "ea75c32046a8be46a47474931df9ffe4"
}

<-

{
    "userToken": "MX8Tndlt3Qx5LdSsygHfq8gJd3v5Qdb4HKfuD7qXKo5RFU3fF1W7dQeHvEqg1eBL"
}