LoadPOIs

Class Description

Loads POIs from a Guide with an optional Boundingbox. Please Note, that the Parameter bid will be renamed to standard-conform building_id beginning api version 20.

RPC Configuration

Rpc Name:

Plain: LoadPOIs
Sha1: cc775f4292b1b25d8175383cfd6355fe7fb35be5

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"floor" : int,
"doubleEncode" : bool = 1,
"deliverImages" : bool = ,
"selectCategories" : bool = ,
"boundingBox" : ?object = null 

Parameter Description

@param int building_id The building_id of the context

@param int floor The Floor-Level to select the POIs on

@param bool doubleEncode [DEPRICATED] will call json_encode on the POIs before returning

@param bool deliverImages Will also return a set of base64 encoded images.

@param bool selectCategories Will also add the Tags categories to the response. Will only work when images are also enabled.

@param object boundingBox A Boundingbox Object where to clip the response data. Send null for global selection.

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:

bid

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.

loadPOIs_LE19

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:

1800

Sample Request

->

{
    "bid": 131,
    "floor": 0
}

<-

{
    "pois": "[{\"latlng\":[49.4987457248,8.46862765748],\"tag\":\"1nnM2WuK\",\"type\":\"#service\",\"displayname\":\"Seminarraum\",\"clusterPriority\":-1,\"showPoiTitle\":false,\"mapImageType\":\"room\",\"showWhileNavigating\":false,\"iconSize\":30},{\"latlng\":[49.4988222502,8.46870134366],\"tag\":\"2AHlaxtq\",\"type\":\"\",\"displayname\":\"Damentoilette\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":null,\"showWhileNavigating\":false,\"iconSize\":null},{\"latlng\":[49.498542305,8.46878514639],\"tag\":\"9syvYUVu\",\"type\":\"\",\"displayname\":\"Hinterausgang\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":null,\"showWhileNavigating\":false,\"iconSize\":null},{\"latlng\":[49.4986621884,8.46858083968],\"tag\":\"aveSbmT5\",\"type\":\"\",\"displayname\":\"Behindertentoilette\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":null,\"showWhileNavigating\":false,\"iconSize\":null},{\"latlng\":[49.4987590446,8.46855677262],\"tag\":\"EuU1MMos\",\"type\":\"#service\",\"displayname\":\"Zentrumsleitungsaasd\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":\"\",\"showWhileNavigating\":false,\"iconSize\":30},{\"latlng\":[49.4986307789,8.46867803779],\"tag\":\"m9cHdjMR\",\"type\":\"\",\"displayname\":\"bermuda funk\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":null,\"showWhileNavigating\":false,\"iconSize\":null},{\"latlng\":[49.4987241878,8.46852481333],\"tag\":\"njMqjt4a\",\"type\":\"\",\"displayname\":\"Haupteingang ABC\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":null,\"showWhileNavigating\":false,\"iconSize\":null},{\"latlng\":[49.4986931114,8.46850693275],\"tag\":\"PqA38Mp5\",\"type\":\"\",\"displayname\":\"Zentrumsleitungs Bearbeitet\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":null,\"showWhileNavigating\":false,\"iconSize\":null},{\"latlng\":[49.4988141455,8.46870912993],\"tag\":\"uJuPddF7\",\"type\":\"\",\"displayname\":\"Herrentoilette\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":null,\"showWhileNavigating\":false,\"iconSize\":null},{\"latlng\":[49.4987900151,8.4686611391],\"tag\":\"xrXiZE0L\",\"type\":\"\",\"displayname\":\"Seminarraum\",\"clusterPriority\":0,\"showPoiTitle\":false,\"mapImageType\":\"\",\"showWhileNavigating\":false,\"iconSize\":30}]"
}