Create a Route

Use this command to create an individual route.

Authorizations: Administrator, Operator

Requests

CODE

POST /api/devices/[Device ID]/updates
cookie: sessionID: [Session ID]

{ 
 "action": "create",
 "deviceID": "[Device ID]", 
 "elementType": "route",
 "fields":
   {
    "name": "[Route name]",
    "startRoute": [true,false],
    "source":
      {
       <Source object>
      },
      "destinations": [
       <Destination object list>
      ]
   }
}

Parameters

Name	Type	Description
action	create	Create the specified element type.
deviceID	string	Device ID retreived via the Get Device Info command.
elementType	route	Create a route element.
name	string	Name of route.
startRoute	Boolean	If route is started after it is created
source	object	Source object. See Source Object Model for definition.
destinations	object list	Optional. List of route destinations. See Destinations Object Model for definition.

Response

CODE

{
  "status": "[success message]"
}