LoadTag

RPC Configuration

Rpc Name:

Plain: LoadTag
Sha1: 8b6dce0e6adf8ae41fa2b4492008f9b2ef33a45e

Rpc Call

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

Rpc Parameters:

"tag" : string,
"categoryLimit" : int = 25 

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:

tag

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

->

{
    "tag": "njMqjt4a"
}

<-

{
    "tag": {
        "tag_id": "njMqjt4a",
        "displayname": "Haupteingang ABC",
        "floor": 0,
        "description": false,
        "accessibilityDescription": false,
        "room_count": 0,
        "force_image_category_id": false,
        "hideFromSearch": false,
        "showPoiTitle": false,
        "clusterPriority": false,
        "mapImageType": false,
        "showWhileNavigating": false,
        "hiddenIntermediate": false,
        "iconSize": null,
        "region": null
    },
    "keywords": [
        {
            "id": 214434,
            "keyword": "#exit"
        },
        {
            "id": 214435,
            "keyword": "Ausgang"
        },
        {
            "id": 214436,
            "keyword": "Exit"
        },
        {
            "id": 214437,
            "keyword": "Eingang"
        },
        {
            "id": 214438,
            "keyword": "Entrance"
        },
        {
            "id": 214439,
            "keyword": "Sortie"
        }
    ],
    "categories": [
        {
            "building_id": 131,
            "category_id": 1,
            "category_handle": "#service",
            "category_name": "Service",
            "active_building": 1,
            "active_tag": 0
        },
        {
            "building_id": 131,
            "category_id": 2,
            "category_handle": "#exit",
            "category_name": "Ausgang",
            "active_building": 1,
            "active_tag": 1
        },
        {
            "building_id": 131,
            "category_id": 3,
            "category_handle": "#beverages",
            "category_name": "Gastronomie",
            "active_building": 1,
            "active_tag": 0
        },
        {
            "building_id": 131,
            "category_id": 4,
            "category_handle": "#sanitary",
            "category_name": "Toiletten",
            "active_building": 1,
            "active_tag": 0
        },
        {
            "building_id": 131,
            "category_id": 5,
            "category_handle": "#_unittestcategory",
            "category_name": "unittestcategory",
            "active_building": 1,
            "active_tag": 0
        }
    ],
    "isQuicksearch": false
}