LoadBuildingsForUser

Class Description

Method requires user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: LoadBuildingsForUser
Sha1: 7cc2ecb13ece44f4743477bf32ad2ed9a3f561e7

Rpc Call

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

Rpc Parameters:

"username" : string,
"filter" : ?string = null 

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.

false

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.

true

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.

SUPERUSER

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Sample Request

->

{
    "username": "testuser"
}

<-

{
    "buildings": [
        {
            "building_id": 131,
            "name": "Unittest-Guide (DO NOT MODIFY)",
            "fromGroup": false,
            "allowEditing": true
        }
    ],
    "nonBuildings": []
}