GetTag

RPC Configuration

Rpc Name:

Plain: GetTag
Sha1: d54162167b8b681bc552c227cb26071bfa9d8b94

Rpc Call

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

Rpc Parameters:

"tagcode" : 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:

tagcode

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

->

{
    "tagcode": "njMqjt4a"
}

<-

{
    "tag": {
        "id": "njMqjt4a",
        "parent_id": "njMqjt4a",
        "building_id": 131,
        "group_id": 1,
        "node_id": 16,
        "floor": 0,
        "displayname": "Haupteingang ABC",
        "attributes": {
            "lat": 49.4987241878,
            "lon": 8.46852481333,
            "id": "njMqjt4a",
            "parent_id": "njMqjt4a",
            "building_id": 131,
            "group_id": 1,
            "node_id": 16,
            "floor": 0,
            "displayname": "Haupteingang ABC"
        }
    }
}