GetRoomByExternalId

Class Description

Rooms can hold an external ID that can then be reverse-resolved with this RPC. This can be helpful to map external services onto room entities within contagt.

RPC Configuration

Rpc Name:

Plain: GetRoomByExternalId
Sha1: 147e5b5e4b963d8262d2220a77415bffdf3e6f4a

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"external_id" : 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,
    "external_id": "test_external_id"
}

<-

{
    "roomId": 7933,
    "buildingId": 131,
    "floor": 0,
    "roomName": {
        "de_DE": "Seminarraum",
        "en_EN": "Seminarraum"
    },
    "color": "333388FF",
    "bgColor": "ffffffff",
    "textColor": "ff000000",
    "connectedTag": "Rtdjby3S",
    "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
    }
}