AddQuickSearchItem

Class Description

Quicksearch-Items are Elements that execute a predefined search on the Search-API with the given searchterm and (optional) second_searchterm, that will result in a single response that can be directly selected as the new active POI. A description can be added for the content administrator to understand the logic of the Quicksearch-Item

RPC Configuration

Rpc Name:

Plain: AddQuickSearchItem
Sha1: 67b2d287fe8ea23d647b9406943261cdaa888385

Rpc Call

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

Rpc I18n Name:

addQuickSearchItemI18n

Rpc Parameters:

"building_id" : int,
"searchterm" : string,
"description" : string,
"second_searchterm" : string =  

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

File Receiver Configuration

This RPC can receive Files.

Maximum Filesize

1 MB

Accepted File MimeTypes:

[
    "image/jpg",
    "image/jpeg",
    "image/png",
    "image/svg+xml"
]

File Param Name(s):

[
    "image"
]

Sample Request

->

{
    "building_id": 131,
    "searchterm": "ausgang",
    "description": "Unittest Searchterm"
}

<-

{
    "status": 4,
    "message": "Der Schnellziel-Suchbegriff wurde erfolgreich hinzugef\u00fcgt.",
    "item": 1
}