LoadQuickSearchItems

RPC Configuration

Rpc Name:

Plain: LoadQuickSearchItems
Sha1: ef57077a445e4a9513925d83381ca74e8e895cd8

Rpc Call

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

Rpc Parameters:

"tag" : string,
"lat" : ?float = null,
"lon" : ?float = null,
"floor" : ?int = null,
"doOrder" : bool = 1 

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.

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

Existing Versionized Executors:

Executor Versions

This RPC has an API Level Vrsion Switch, that will allow to execute different paths on differnet API Levels. The accepted and response parameters might change when using a versionized constructor.

loadQuickSearchItems_LE21

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

->

{
    "tag": "njMqjt4a",
    "floor": 0,
    "lat": 0,
    "lon": 0
}

<-

[
    {
        "searchTerm": "ausgang",
        "description": "Unittest Searchterm",
        "img": "http:\/\/172.18.1.12\/img\/content\/buildings\/qasearchterm\/131\/678f65121c6cb.png",
        "isRoom": true,
        "contagtId": "9syvYUVu",
        "distance": 0
    }
]