GetHeatMapData

RPC Configuration

Rpc Name:

Plain: GetHeatMapData
Sha1: e535a87f8076514dd0dac13dcc60411406e3c3da

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"floor" : int,
"startDate" : string = ,
"endDate" : string = ,
"operatingSystem" : ?string = null 

Parameter Description

Loads the Available Heatmap Points.
@param int building_id

@param int floor

@param null startDate

@param null endDate

@param string|null operatingSystem

@return array|int|mixed

@throws APIException

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.

LOCAL_ADMINISTRATOR

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,
    "floor": 0,
    "startDate": "03.12.2020 14:18:06",
    "endDate": "04.01.2021 14:18:06"
}