Zum Hauptinhalt springen

DownloadListOfBuildings

RPC Configuration

Rpc Name:

Plain: DownloadListOfBuildings
Sha1: 15e2ac4e793e2c3987a9e87ce9ad9d1f8c708089
Rpc Call

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

Rpc Parameters:

"rangeStart" : int,
"rangeEnd" : int,
"lat" : float = -181,
"lon" : float = -91,
"radius" : ?float = 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.

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:

true

Cache Time to Live:

60

Sample Request

->

{
"rangeStart": 0,
"rangeEnd": 10
}

<-

[
{
"id": 131,
"name": "Unittest-Guide (DO NOT MODIFY)",
"address": {
"id": 21,
"thoroughfare": "Mittelstra\u00dfe",
"thoroughfare_no": 42,
"city": "Mannheim",
"postalcode": 68169,
"lon": 8.4685818,
"lat": 49.4987159,
"administrativarea": "Baden-W\u00fcrttemberg",
"country": "",
"country_code": ""
},
"distance": 0,
"roottag": "njMqjt4a",
"position": {
"lat": 49.4987159,
"lon": 8.4685818
},
"auth": false
}
]