LoadGroups

Class Description

Method requires user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: LoadGroups
Sha1: 3b594ff5d66e924b17570795ca47187c957521b2

Rpc Call

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

Rpc Parameters:

"filter" : ?string = null,
"rangeStart" : ?int = null,
"rangeEnd" : ?int = 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

->

[]

<-

{
    "groups": [
        {
            "0": "1",
            "id": "1",
            "1": "Global User Group",
            "name": "Global User Group",
            "2": "This is the Global User Group, that every user is ",
            "comment": "This is the Global User Group, that every user is "
        },
        {
            "0": "2",
            "id": "2",
            "1": "viewer group",
            "name": "viewer group",
            "2": "this group may view all buildings, but not edit",
            "comment": "this group may view all buildings, but not edit"
        },
        {
            "0": "3",
            "id": "3",
            "1": "admin group",
            "name": "admin group",
            "2": "all read\/write admins",
            "comment": "all read\/write admins"
        },
        {
            "0": "4",
            "id": "4",
            "1": "public-viewer-group",
            "name": "public-viewer-group",
            "2": "All Public Buildings to be viewed",
            "comment": "All Public Buildings to be viewed"
        },
        {
            "0": "5",
            "id": "5",
            "1": "UnittestGroupName",
            "name": "UnittestGroupName",
            "2": "UnittestGroupDescription",
            "comment": "UnittestGroupDescription"
        }
    ]
}