GetSearchProviders

Class Description

Loads all Search Providers that have been configured for the given building.

RPC Configuration

Rpc Name:

Plain: GetSearchProviders
Sha1: fa6df1a744f78e0d1553bd681becd8a3cf43d54c

Rpc Call

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

Rpc Parameters:

"building_id" : int 

Parameter Description

@param int building_id The context providing parameter.

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

Has Named Parameters:

true

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.

SUPERUSER

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
}

<-

[
    {
        "name": "default",
        "resultKey": "tags",
        "config": null
    },
    {
        "name": "default",
        "resultKey": "tags",
        "config": null
    },
    {
        "name": "default",
        "resultKey": "tags",
        "config": null
    },
    {
        "name": "default",
        "resultKey": "tags",
        "config": null
    },
    {
        "name": "default",
        "resultKey": "tags",
        "config": null
    }
]