SaveModuleParameters

Class Description

This class handles the api request for saving module parameters.

RPC Configuration

Rpc Name:

Plain: SaveModuleParameters
Sha1: b600c67286d2034af09789486908de09c7696e90

Rpc Call

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

Rpc Parameters:

"buildingId" : int,
"moduleId" : int,
"parameters" : array 

Parameter Description

Saves the modules parameters.
@param int buildingId The id of the building.

@param int moduleId The id of the module.

@param array parameters An array containing the parameters that shall be saved.

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:

buildingId

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.

LOCAL_ADMINISTRATOR

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

->

{
    "buildingId": 131,
    "moduleId": 51,
    "parameters": [
        "screensaver",
        "settings2"
    ]
}

<-

false