Field Squared API Services

<back to all web services

RouteList

The following routes are available for this service:
GET/{Workspace}/RouteList
GET/{Workspace}/RouteList/Count
import java.math.*
import java.util.*
import net.servicestack.client.*


open class RouteList
{
    var Workspace:String? = null
    var DateGenerated:String? = null
    var Routes:ArrayList<Route> = ArrayList<Route>()
    var RecordsAvailable:Long? = null
}

/**
* Contains the data for a route within the system.
*/
open class Route
{
    var Workspace:String? = null
    var AssignedWorkspace:String? = null
    var ObjectId:String? = null
    var VersionId:String? = null
    var BasedOn:String? = null
    var Created:String? = null
    var LastUpdated:String? = null
    var Date:String? = null
    var StartTime:String? = null
    var EndTime:String? = null
    var UserId:String? = null
    var Name:String? = null
    var Type:String? = null
    var Segments:ArrayList<RouteSegment> = ArrayList<RouteSegment>()
    var TotalTime:Int? = null
    var TotalDistance:Double? = null
    var Nodes:ArrayList<RouteNode> = ArrayList<RouteNode>()
}

open class RouteSegment
{
    var Time:Int? = null
    var Distance:Double? = null
    var Start:String? = null
    var End:String? = null
    var Geometry:ArrayList<Location> = ArrayList<Location>()
    var DrivingDirections:ArrayList<String> = ArrayList<String>()
    var EndNode:RouteNode? = null
}

open class Location
{
    var y:Double? = null
    var x: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 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 RouteList DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /{Workspace}/RouteList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json