SaveBeacon

RPC Configuration

Rpc Name:

Plain: SaveBeacon
Sha1: 1142b3beba8f49adc18550b9df8769959bc63ceb

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"beacon" : array,
"floor" : int,
"lat" : float,
"lon" : float,
"geofence_distance" : float,
"device_type" : ?string = null 

Parameter Description

@param int building_id Building ID is transmitted for context control!

@param array[Beacon] beacon

An Array of the Beacon defined like this:

[
    "beaconId" -> int,
    "beaconUUID" -> string,
    "beaconMajor" -> int,
    "beaconMinor" -> int,
    "devicetype" -> null, 'floating' or 'relative',
    "installed_on" -> iso date,
    "height" -> float
]

@param ?string device_type The DeviceType of the Beacon as null, 'floating' or 'relative'

@return array|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.

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.

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,
    "beacon": {
        "beaconUUID": "c0117467-c011-7467-c011-7467c0117467",
        "beaconMajor": 1,
        "beaconMinor": 432,
        "beaconId": 1337,
        "fcc": "3.0",
        "height": "2.5",
        "installed_on": "2021-01-04 11:10:00",
        "devicetype": ""
    },
    "floor": 0,
    "lat": 49.49864912826943,
    "lon": 8.468971699476244,
    "geofence_distance": 0
}

<-

{
    "success": true,
    "beaconId": 5306
}