LoadMultiDestRoute

RPC Configuration

Rpc Name:

Plain: LoadMultiDestRoute
Sha1: f186320d220dbf08483022ef8039bc7aec23f426

Rpc Call

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

Rpc Parameters:

"building_id" : int 

Parameter Description

Loads the Multi-Destination Routes for a Building
@param integer building_id

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

<-

{
    "routes": [
        {
            "id": 113,
            "name": "Test-Rund-Route",
            "description": "",
            "resumable": true,
            "destinations": [
                {
                    "destination": "1nnM2WuK",
                    "isAnkerpoint": false
                },
                {
                    "destination": "dSK0vx1j",
                    "isAnkerpoint": false
                },
                {
                    "destination": "TaZRVdYF",
                    "isAnkerpoint": false
                }
            ],
            "computed": []
        },
        {
            "id": 114,
            "name": "Unittest Route",
            "description": "Die Route, erstellt vom Unittest",
            "resumable": true,
            "destinations": [
                {
                    "destination": "1nnM2WuK",
                    "isAnkerpoint": false
                },
                {
                    "destination": "dSK0vx1j",
                    "isAnkerpoint": false
                },
                {
                    "destination": "TaZRVdYF",
                    "isAnkerpoint": false
                }
            ],
            "computed": []
        }
    ]
}