Field Squared API Services

Route

Contains the data for a route within the system.

The following routes are available for this service:
GET,POST,DELETE	/{Workspace}/Route/{ObjectId}
GET	/{Workspace}/Route/{UserId}/{Date}

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


/**
* 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 Route 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}/Route/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","Created":"String","LastUpdated":"String","Date":"String","StartTime":"String","EndTime":"String","UserId":"String","Name":"String","Type":"String","Segments":[{"Time":0,"Distance":0,"Start":"String","End":"String","Geometry":[{"y":0,"x":0}],"DrivingDirections":["String"],"EndNode":{"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"}}],"TotalTime":0,"TotalDistance":0,"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"}]}