LoadCategories

Class Description

Load all Categories that are used within a Guide. Optinally load "hidden" categories and count Category Entries.

RPC Configuration

Rpc Name:

Plain: LoadCategories
Sha1: b34ca89bcce599dc8a7f8d32a626af297908c3fc

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"onlyVisible" : bool = 1,
"countItems" : bool =  

Parameter Description

param int building_id The Context Parameter identifying the Guide
@param bool onlyVisible Will only load those categories that should be display in the List of Apps. Categories can also be "hidden" so they will be just used for internal processing.

@param bool countItems If true, each Categorie will also expose the number of items included.

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
}

<-

[
    {
        "category_id": 1,
        "category_handle": "#service",
        "default_name": "Service",
        "category_name": "Service"
    },
    {
        "category_id": 2,
        "category_handle": "#exit",
        "default_name": "Ausgang",
        "category_name": "Ausgang"
    },
    {
        "category_id": 3,
        "category_handle": "#beverages",
        "default_name": "Gastronomie",
        "category_name": "Gastronomie"
    },
    {
        "category_id": 4,
        "category_handle": "#sanitary",
        "default_name": "Toiletten",
        "category_name": "Toiletten"
    }
]