SaveGroup

Class Description

Method requires user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: SaveGroup
Sha1: 9b726c632b42861fa4ce88bc4d725ac265853f61

Rpc Call

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

Rpc Parameters:

"group_id" : int,
"groupName" : string,
"groupDescription" : string 

Parameter Description

Sending a GroupId === -1 will create a new Group

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

->

{
    "group_id": -1,
    "groupName": "UnittestGroupName",
    "groupDescription": "UnittestGroupDescription"
}

<-

true