Search

RPC Configuration

Rpc Name:

Plain: Search
Sha1: 3daa79d9a73b202a6e6f105c62324da01c17cd3a

Rpc Call

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

Rpc Parameters:

"value" : string,
"buildingId" : int,
"lat" : ?float = null,
"lon" : ?float = null,
"floor" : ?int = null,
"userToken" : ?string = null,
"sharedSecret" : ?string = null,
"disableSpellchecking" : bool = ,
"forceDistanceOrdering" : bool =  

Parameter Description

Search for anything within a Guide. All POIs, Rooms etc can be found. All these results will be listed in the standard section.

• Buildings can have custom search provider plugins for external systems. These will respond when they are configured for the requested building and will be added to the result under a key of the providers name in the providers section.
• If lat, lon and Floor are defined, the results can be ordered by distance instead of relevance.
• If userToken and sharedSecret are defined, the search can also find assets.
  @param bool disableSpellchecking Do not run spellcheck algorithms on the search term.

@param bool forceDistanceOrdering Enable exclusive ordering by distance instead of result relevance.

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:

buildingId

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.

Search_LETV12

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Account Method Authentication

This RPC requires Account Method Authenticaton with the following configuration:

Requires Account Login:

tipp

The Account login is not the default api login. See LoginViaUser and LoginViaEmail

false

Account Usertoken Parameter Name:

tipp

This Usertoken is not the same one, as the api login usertoken.

userToken

Account Shared Secret Parameter Name:

sharedSecret

Requires Asset Permission:

false

Sample Request

->

{
    "0": "contagt",
    "buildingId": 131
}

<-

{
    "standard": [
        {
            "tag": "he7csH6n",
            "image": "http:\/\/172.18.1.12\/img\/content\/buildings\/131.0.png",
            "attributes": {
                "id": "he7csH6n",
                "parent_id": "njMqjt4a",
                "building_id": 131,
                "group_id": 1,
                "node_id": 151,
                "floor": 2,
                "displayname": "contagts GmbHs",
                "description": "The Indoorvators of Navigation - bringing you this App ;)",
                "image": "http:\/\/172.18.1.12\/img\/content\/buildings\/131.0.png",
                "attributes": {
                    "lat": 49.4988131269,
                    "lon": 8.46859088095,
                    "id": "he7csH6n",
                    "parent_id": "njMqjt4a",
                    "building_id": 131,
                    "group_id": 1,
                    "node_id": 151,
                    "floor": 2,
                    "displayname": "contagts GmbHs",
                    "description": "The Indoorvators of Navigation - bringing you this App ;)",
                    "image": "http:\/\/172.18.1.12\/img\/content\/buildings\/131.0.png"
                }
            },
            "region": null
        }
    ],
    "providers": [],
    "spellcheck": {
        "applied": false
    }
}