FindAsset

RPC Configuration

Rpc Name:

Plain: FindAsset
Sha1: c9630ed58c4d6ffe1275b56406f7546b6392b36b

Rpc Call

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

Rpc Parameters:

"userToken" : string,
"sharedSecret" : string,
"lat" : float,
"lon" : float,
"radius" : float,
"searchKey" : string = ,
"limit" : int = 50 

Parameter Description

Finds shared assets withing the region.
@param String userToken

@param String sharedSecret

@param float lat

@param float lon

@param float radius Searchradius in Meter

@param integer limit

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.

false

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:

false

Account Method Authentication

This RPC requires Account Method Authenticaton with the following configuration:

Requires Account Login:

tipp

The Account login is not the default api login. See LoginViaUser and LoginViaEmail

true

Account Usertoken Parameter Name:

tipp

This Usertoken is not the same one, as the api login usertoken.

userToken

Account Shared Secret Parameter Name:

sharedSecret

Requires Asset Permission:

true

Sample Request

->

{
    "userToken": "MX8Tndlt3Qx5LdSsygHfq8gJd3v5Qdb4HKfuD7qXKo5RFU3fF1W7dQeHvEqg1eBL",
    "sharedSecret": "ea75c32046a8be46a47474931df9ffe4",
    "lat": 52,
    "lon": 8,
    "radius": 40000000,
    "searchKey": "TestAsset"
}

<-

[
    {
        "assetAlias": "My_Third_Asset",
        "assetName": "Mein drittes TestAsset",
        "attributes": {
            "Asset Attribute from Unittest": "The Attributes Value",
            "Gem\u00fcsekiste": "Tomaten, \u00c4pfel und Co",
            "Gem\u00fcsekisten": "Gurken und Tomaten"
        },
        "location": {
            "lat": 49.498699210845,
            "lon": 8.4686733037234,
            "building_id": 131,
            "root_tag": "njMqjt4a",
            "floor": 0
        },
        "remainingMinutes": 0,
        "distance": 280074.8
    },
    {
        "assetAlias": "My_Fourth_Asset",
        "assetName": "Mein viertes TestAsset",
        "attributes": {},
        "location": {
            "lat": 49.49843,
            "lon": 8.46342,
            "building_id": 131,
            "root_tag": "njMqjt4a",
            "floor": 0
        },
        "remainingMinutes": 0,
        "distance": 280074.8
    }
]