Start or Stop Routes and Destinations

Use this command to start or stop individual routes or individual destinations

Authorizations: Administrator, Operator

Requests

^{POST /api/devices/[Device ID]/commands
cookie: sessionID: [Session ID]

{
"deviceID": "[Device ID]",
"command": "[command]",
"parameters": {
"routeID": "[Route ID]",
"destinationID: "[Destination ID]"
}
}}

Parameters

Name	Type	Description
deviceID	string	Device ID retreived via the Get Device Info command.
command	start-route stop-route start-destination stop-destination	Command to issue to the route or destination
routeID	string	Route ID retrieved via the Get Device Configuration command.
destinationID	string	(start-destination and stop-destination commands only) Destination ID retrieved via the Get Device Configuration command.

Response

^{[
{
"action": "command",
"command": "start-route",
"parameters": {
"routeID": "[Route ID]"
},
"deviceID": "[Device ID]",
"createdAt": [Date/time in Unix time],
"completedAt": 0,
"result": null,
"state": "pending",
"_id": "a5x4-7KEApdS0UuAUUCSog"
}
]}

Note

Status of the state property can be polled via the Get Device Configuration command. It may take several seconds to complete the command.