Field Squared API Services

ProposeRouteRequest

The following routes are available for this service:
POST	/{Workspace}/ProposeRoute

import java.math.*
import java.util.*
import net.servicestack.client.*


open class ProposeRouteRequest
{
    var Workspace:String? = null
    var Nodes:ArrayList<RouteNode> = ArrayList<RouteNode>()
    var AllowReorder:Boolean? = null
    var StartLocation:Location? = null
    var EndLocation:Location? = null
    var ShortestDistance:Boolean? = null
    var StartTime:String? = null
    var StartClockAtFirstNode:Boolean? = null
    var RoundStartTimes:Int? = null
    var TransitionTime:Int? = null
    var LunchStart:String? = null
    var LunchDuration:Int? = null
    var Time:Int? = null
    var RealTime:Int? = null
    var Distance:Double? = null
}

open class RouteNode : ClassedItem()
{
    var Location:Location? = null
    var StopTime:Int? = null
    var Schedule:Schedule? = null
    var Name:String? = null
}

open class ClassedItem
{
    var ObjectId:String? = null
    var Class:String? = null
    var VersionId:String? = null
    var Ancestors:ArrayList<String> = ArrayList<String>()
    var Type:String? = null
}

open class Location
{
    var y:Double? = null
    var x:Double? = null
}

open class Schedule
{
    var Workspace:String? = null
    var ObjectId:String? = null
    var VersionId:String? = null
    var BasedOn:String? = null
    var Start:String? = null
    var End:String? = null
    var TimeZone:String? = null
    var Users:ArrayList<String> = ArrayList<String>()
    var Teams:ArrayList<String> = ArrayList<String>()
    var Data:HashMap<String,Object> = HashMap<String,Object>()
}

Kotlin ProposeRouteRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/ProposeRoute HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","Nodes":[{"Location":{"y":0,"x":0},"StopTime":0,"Schedule":{"Workspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","Start":"String","End":"String","TimeZone":"String","Users":["String"],"Teams":["String"],"Data":{"String":{}}},"Name":"String","ObjectId":"String","Class":"String","VersionId":"String","Ancestors":["String"],"Type":"String"}],"AllowReorder":false,"StartLocation":{"y":0,"x":0},"EndLocation":{"y":0,"x":0},"ShortestDistance":false,"StartTime":"String","StartClockAtFirstNode":false,"RoundStartTimes":0,"TransitionTime":0,"LunchStart":"String","LunchDuration":0,"Time":0,"RealTime":0,"Distance":0}