LoadUsersForBuilding

Class Description

Method requires user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: LoadUsersForBuilding
Sha1: ba586d5c9096652cd36a4a8d9a872e9cbbe18d8f

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"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.

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.

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

->

{
    "building_id": 131
}

<-

{
    "users": [
        {
            "id": 4,
            "name": "testuser",
            "group_id": 1,
            "gedit": 1,
            "uedit": 0
        },
        {
            "id": 5,
            "name": "thor",
            "group_id": 1,
            "gedit": null,
            "uedit": 0
        },
        {
            "id": 6,
            "name": "deleter",
            "group_id": 1,
            "gedit": null,
            "uedit": 0
        },
        {
            "id": 7,
            "name": "noadmin",
            "group_id": 1,
            "gedit": null,
            "uedit": 0
        }
    ]
}