GetTagCategories

Class Description

Finds all Categories that are connected to a specific Tag Id. It will only result the Categories that start with the filter string. A default limit of 25 Categories is defined, but can be overwritten with a maximum of 100.

RPC Configuration

Rpc Name:

Plain: GetTagCategories
Sha1: 7ebcb6b6540e961452c1354b7273138411adaea5

Rpc Call

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

Rpc Parameters:

"tag" : string,
"filter" : ?string = null,
"limit" : 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"
}

<-

{
    "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
        }
    ]
}