LoadBeacons

RPC Configuration

Rpc Name:

Plain: LoadBeacons
Sha1: 77f6344552ccb5ac614b3624a29d7a641c662817

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"floor" : ?int = null 

Parameter Description

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

@param ?int floor

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

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

->

{
    "building_id": 131
}

<-

{
    "beacons": [
        {
            "data": {
                "beaconUUID": "c0117467-c011-7467-c011-7467c0117467",
                "beaconId": 5303,
                "beaconMajor": 131,
                "beaconMinor": 1337,
                "content": "",
                "geofence_distance": 0,
                "fcc": 3,
                "height": 2.5
            },
            "bId": 131,
            "floor": 0,
            "devicetype": "",
            "lat": 49.498788052851,
            "lon": 8.4686096012592,
            "confidence": 1000,
            "installed_on": "2025-01-21 09:11:29"
        },
        {
            "data": {
                "beaconUUID": "c0117467-c011-7467-c011-7467c0117467",
                "beaconId": 5304,
                "beaconMajor": 131,
                "beaconMinor": 1338,
                "content": "",
                "geofence_distance": 0,
                "fcc": 3,
                "height": 2.5
            },
            "bId": 131,
            "floor": 0,
            "devicetype": "",
            "lat": 49.498696597842,
            "lon": 8.4685505926609,
            "confidence": 1000,
            "installed_on": "2025-01-21 09:11:29"
        },
        {
            "data": {
                "beaconUUID": "c0117467-c011-7467-c011-7467c0117467",
                "beaconId": 5305,
                "beaconMajor": 131,
                "beaconMinor": 1339,
                "content": "",
                "geofence_distance": 0,
                "fcc": 3,
                "height": 2.5
            },
            "bId": 131,
            "floor": 0,
            "devicetype": "",
            "lat": 49.498641289253,
            "lon": 8.4687101840973,
            "confidence": 1000,
            "installed_on": "2025-01-21 09:11:29"
        }
    ]
}