CreateAudioDescription

Class Description

Creates a new Audiodescription(location)

RPC Configuration

Rpc Name:

Plain: CreateAudioDescription
Sha1: ae5a4cde1ff459071c582309e847dc99e6e0c4e3

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"mode" : int,
"submit_user" : int,
"device_coordinate_X" : float,
"device_coordinate_Y" : float,
"device_coordinate_floor" : float,
"coordinate_X" : float,
"coordinate_Y" : float,
"coordinate_floor" : float,
"emailAddress" : ?string = null,
"fullName" : ?string = null,
"descriptionText" : ?string = null 

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,
    "mode": 3,
    "submit_user": 1,
    "device_coordinate_X": 75.2,
    "device_coordinate_Y": 75.2,
    "device_coordinate_floor": 1,
    "emailAddress": "test@web.de",
    "fullName": "Max Mustermann",
    "descriptionText": "Links am Baum ist ein M\u00fclleimer. Rechts davon ist die Haltestelle.",
    "coordinate_X": 75.2,
    "coordinate_Y": 75.2,
    "coordinate_floor": 1
}

<-

true