Zum Hauptinhalt springen

LoadGuideMessages

Class Description

Loads all configured guide messages for a given Building-ID and the Message Names

RPC Configuration

Rpc Name:

Plain: LoadGuideMessages
Sha1: 86b680f15723feba816840551931f7f37921c150
Rpc Call

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

Rpc Parameters:

"building_id" : int,
"message_ids" : array|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.

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

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

->

{
"building_id": 131,
"message_ids": [
"motd",
"ar_info",
"initial_navigation",
"background_location_permission",
"info_visually_impaired"
]
}

<-

{
"ar_info": "Bewege deine Kamera hin und her, um deine Umgebung zu scannen.",
"initial_navigation": "Die Navigation dient lediglich als Hilfestellung.\n\nDa die Ortungsgenauigkeit schwanken kann, ersetzt sie die menschlichen Sinne nicht.\n\nVerwende die Standort-Informationen mit angemessener Sorgfalt.",
"background_location_permission": "Die App nutzt Standortdaten f\u00fcr die Navigation, und um auf Events in der N\u00e4he hinzuweisen, auch wenn die App geschlossen ist.",
"info_visually_impaired": "Bitte beachten\n\nDie Navigation ist nicht f\u00fcr blinde Nutzer geeignet.\n\nDie Ortungsgenauigkeit schwankt und die Routenanweisungen sind starr. Sie passen sich nicht an deine Ausrichtung an.\n\nNutze die Funktion nur mit sehender Begleitung"
}