Field Squared API Services

RouteList

The following routes are available for this service:
GET	/{Workspace}/RouteList
GET	/{Workspace}/RouteList/Count

namespace Field2Office.API.Model

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Location() = 
        member val y:Double = new Double() with get,set
        member val x:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type ClassedItem() = 
        member val ObjectId:String = null with get,set
        member val Class:String = null with get,set
        member val VersionId:String = null with get,set
        member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type Schedule() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Start:String = null with get,set
        member val End:String = null with get,set
        member val TimeZone:String = null with get,set
        member val Users:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Data:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

    [<AllowNullLiteral>]
    type RouteNode() = 
        inherit ClassedItem()
        member val Location:Location = null with get,set
        member val StopTime:Int32 = new Int32() with get,set
        member val Schedule:Schedule = null with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type RouteSegment() = 
        member val Time:Int32 = new Int32() with get,set
        member val Distance:Double = new Double() with get,set
        member val Start:String = null with get,set
        member val End:String = null with get,set
        member val Geometry:ResizeArray<Location> = new ResizeArray<Location>() with get,set
        member val DrivingDirections:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val EndNode:RouteNode = null with get,set

    ///<summary>
    ///Contains the data for a route within the system.
    ///</summary>
    [<AllowNullLiteral>]
    type Route() = 
        member val Workspace:String = null with get,set
        member val AssignedWorkspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Created:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val Date:String = null with get,set
        member val StartTime:String = null with get,set
        member val EndTime:String = null with get,set
        member val UserId:String = null with get,set
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val Segments:ResizeArray<RouteSegment> = new ResizeArray<RouteSegment>() with get,set
        member val TotalTime:Int32 = new Int32() with get,set
        member val TotalDistance:Double = new Double() with get,set
        member val Nodes:ResizeArray<RouteNode> = new ResizeArray<RouteNode>() with get,set

    [<AllowNullLiteral>]
    type RouteList() = 
        member val Workspace:String = null with get,set
        member val DateGenerated:String = null with get,set
        member val Routes:ResizeArray<Route> = new ResizeArray<Route>() with get,set
        member val RecordsAvailable:Int64 = new Int64() with get,set

F# 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