Field Squared API Services

<back to all web services

ProposeRouteRequest

The following routes are available for this service:
POST/{Workspace}/ProposeRoute
namespace Field2Office.API.Model

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

    [<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 Location() = 
        member val y:Double = new Double() with get,set
        member val x:Double = new Double() 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 ProposeRouteRequest() = 
        member val Workspace:String = null with get,set
        member val Nodes:ResizeArray<RouteNode> = new ResizeArray<RouteNode>() with get,set
        member val AllowReorder:Boolean = new Boolean() with get,set
        member val StartLocation:Location = null with get,set
        member val EndLocation:Location = null with get,set
        member val ShortestDistance:Boolean = new Boolean() with get,set
        member val StartTime:String = null with get,set
        member val StartClockAtFirstNode:Boolean = new Boolean() with get,set
        member val RoundStartTimes:Int32 = new Int32() with get,set
        member val TransitionTime:Int32 = new Int32() with get,set
        member val LunchStart:String = null with get,set
        member val LunchDuration:Int32 = new Int32() with get,set
        member val Time:Int32 = new Int32() with get,set
        member val RealTime:Int32 = new Int32() with get,set
        member val Distance:Double = new Double() with get,set

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