GetModulesAndConfiguration

Class Description

This class handles the api request for getting all modules and their configuration.

RPC Configuration

Rpc Name:

Plain: GetModulesAndConfiguration
Sha1: 8a0c7f92d5ceb79b1d3ff09e2c4fddaa87a632b4

Rpc Call

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

Rpc Parameters:

"buildingId" : int 

Parameter Description

Gets all modules and their configuration with a given building id.
@param int buildingId The id of the building.

@return array|null An array containing the modules. Null if no modules could be found, or an error happened.

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.

STANDARD_USER

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
}

<-

false