LoadAreas

RPC Configuration

Rpc Name:

Plain: LoadAreas
Sha1: c2fb16bcb9862044d7c0e93a9840e37c6aef37cd

Rpc Call

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

Rpc Parameters:

"bid" : int 

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:

bid

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

->

{
    "bid": 131
}

<-

{
    "regionData": [
        {
            "id": 2,
            "name": {
                "de_DE": "Zu ladende Region",
                "en_EN": null
            },
            "desc": {
                "de_DE": "Diese Region muss vom Test geladen werden",
                "en_EN": null
            },
            "vertices": [
                {
                    "ord": 0,
                    "lat": 49.49857683507091,
                    "lon": 8.468232750892641
                },
                {
                    "ord": 1,
                    "lat": 49.499048916438895,
                    "lon": 8.46861630678177
                },
                {
                    "ord": 2,
                    "lat": 49.498688323332395,
                    "lon": 8.46923589706421
                },
                {
                    "ord": 3,
                    "lat": 49.498421796285086,
                    "lon": 8.468932807445528
                }
            ]
        },
        {
            "id": 3,
            "name": {
                "de_DE": "Region added by Test",
                "en_EN": null
            },
            "desc": {
                "de_DE": "The region by Test",
                "en_EN": null
            },
            "vertices": [
                {
                    "ord": 0,
                    "lat": 49.4987963273435,
                    "lon": 8.468922078609468
                },
                {
                    "ord": 1,
                    "lat": 49.49848625067144,
                    "lon": 8.46939414739609
                },
                {
                    "ord": 2,
                    "lat": 49.49881374732299,
                    "lon": 8.469716012477877
                },
                {
                    "ord": 3,
                    "lat": 49.49892349305105,
                    "lon": 8.469506800174715
                }
            ]
        }
    ]
}