SaveRoom

RPC Configuration

Rpc Name:

Plain: SaveRoom
Sha1: 7d3511ae4c3692cd84803fe68f95adc2ed28c89b

Rpc Call

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

Rpc I18n Name:

saveRoomI18n

Rpc Parameters:

"building_id" : int,
"tag" : string,
"floor" : int,
"polygon" : array,
"roomUri" : ?string = null,
"room_id" : int = -1,
"room_name" : ?string = null,
"externalIdentifier" : ?string = null,
"xetalIdentifier" : ?string = null,
"mode" : int = -1,
"agColor" : string = #000000,
"bgColor" : string = #ffffff,
"tColor" : string = #00ff00 

Parameter Description

@param int building_id

@param string tag

@param int floor

@param polygon

@param string content

@param string headline

@param string uri

@param null|string roomUri

@param int room_id

@param null|string room_name

@param int mode

@param string agColor

@param string bgColor

@param string tColor

@return array

@throws \Exception

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.

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

Sample Request

->

{
    "building_id": 131,
    "tag": "njMqjt4a",
    "floor": 0,
    "polygon": [
        {
            "lat": 48.805013017102,
            "lng": 9.2077566683292
        },
        {
            "lat": 48.804911439441,
            "lng": 9.2078156769276
        },
        {
            "lat": 48.804735665438,
            "lng": 9.2077995836735
        },
        {
            "lat": 48.804506010032,
            "lng": 9.2077741026878
        },
        {
            "lat": 48.804549291324,
            "lng": 9.2076762020588
        },
        {
            "lat": 48.804604938644,
            "lng": 9.2075715959072
        },
        {
            "lat": 48.80466323577,
            "lng": 9.2074643075466
        },
        {
            "lat": 48.804718882963,
            "lng": 9.2073771357536
        },
        {
            "lat": 48.804778063244,
            "lng": 9.2072832584381
        },
        {
            "lat": 48.804842543172,
            "lng": 9.2071813344955
        },
        {
            "lat": 48.804909672872,
            "lng": 9.207090139389
        },
        {
            "lat": 48.804959136804,
            "lng": 9.2070981860161
        },
        {
            "lat": 48.805032449327,
            "lng": 9.2073301970959
        },
        {
            "lat": 48.805104878462,
            "lng": 9.2075635492802
        },
        {
            "lat": 48.805096045646,
            "lng": 9.2076386511326
        },
        {
            "lat": 48.805043932002,
            "lng": 9.2077204585075
        }
    ],
    "room_id": -1,
    "agColor": "#00000000",
    "bgColor": "#ffffffff",
    "tColor": "#ff000000",
    "room_name": "Flamingosooososo",
    "externalIdentifier": "TestID1",
    "mode": 0
}

<-

{
    "msg": "Gespeichert.",
    "roomId": 7934,
    "rsuccess": "",
    "handle": "http:\/\/172.18.1.12\/rooms\/?company=ArhV1sPA6t5zFZH4MSfbPdNk04K32hMwkYQyXp59RLZf67Lf"
}