LoadRoom

Class Description

Load a Room of a Building.

RPC Configuration

Rpc Name:

Plain: LoadRoom
Sha1: d9c2d93e92a6a74769e49726b198b90c6828407b

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"room_id" : int 

Parameter Description

@param int building_id Transmitted for context control!

@param room_id The room ID to load

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,
    "room_id": 7933
}

<-

{
    "room": {
        "roomId": 7933,
        "buildingId": 131,
        "floor": 0,
        "roomName": {
            "de_DE": "Seminarraum",
            "en_EN": "Seminarraum"
        },
        "color": "333388FF",
        "bgColor": "ffffffff",
        "textColor": "ff000000",
        "connectedTag": "1nnM2WuK",
        "roomHandle": "iRrojiZuOSexLrL7fOTdLPJMqoHmW9HK",
        "roomUri": "iRrojiZuOSexLrL7fOTdLPJMqoHmW9HK",
        "imageUri": "http:\/\/172.18.1.12\/rooms\/img\/iRrojiZuOSexLrL7fOTdLPJMqoHmW9HK.png",
        "panoramaUri": "http:\/\/172.18.1.12\/rooms\/panorama\/iRrojiZuOSexLrL7fOTdLPJMqoHmW9HK.jpg",
        "panoramaThumbUri": null,
        "contentMode": 0,
        "externalIdentifier": "test_external_id",
        "xetalIdentifier": "test_external_generic_id",
        "statistics": {
            "visitors": null,
            "offset": null,
            "maxVisitors": null
        }
    },
    "room_content": "",
    "room_heading": "Seminarraum"
}