CreateMultiDestRoute

RPC Configuration

Rpc Name:

Plain: CreateMultiDestRoute
Sha1: 9c7929ff8199636f9ad59167a7a55e90e52d651e

Rpc Call

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

Rpc I18n Name:

createMultiDestRouteI18n

Rpc Parameters:

"building_id" : int,
"name" : string,
"description" : string,
"destinations" : array,
"image" : ?array = null,
"resumable" : bool = 1 

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

Has Named Parameters:

true

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.

true

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.

ADMINISTRATOR

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

Existing Versionized Executors:

Executor Versions

This RPC has an API Level Vrsion Switch, that will allow to execute different paths on differnet API Levels. The accepted and response parameters might change when using a versionized constructor.

createMultiDestRoute_LE21

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

File Receiver Configuration

This RPC can receive Files.

Maximum Filesize

4 MB

Accepted File MimeTypes:

[
    "image/png",
    "image/jpeg",
    "image/jpeg",
    "image/svg+xml"
]

File Param Name(s):

[
    "image"
]

Sample Request

->

{
    "building_id": 131,
    "name": "Unittest Route",
    "description": "Die Route, erstellt vom Unittest",
    "destinations": [
        {
            "destination": "aveSbmT5",
            "isAnkerpoint": false
        },
        {
            "destination": "5dQg3abu",
            "isAnkerpoint": false
        },
        {
            "destination": "dSK0vx1j",
            "isAnkerpoint": false
        }
    ]
}

<-

{
    "route_id": 114,
    "items": 3
}