Field Squared API Services

<back to all web services

OptimizeScheduleRequest

The following routes are available for this service:
POST/{Workspace}/OptimizeSchedule
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 OptimizeScheduleRequest() = 
        member val Workspace:String = null with get,set
        member val UserId:String = null with get,set
        member val Date:String = null with get,set
        member val TaskIds:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val RoundStartTimes:Int32 = new Int32() with get,set
        member val TransitionTime:Int32 = new Int32() with get,set
        member val StartTime:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StartLocation:Location = null with get,set
        member val EndLocation:Location = null with get,set
        member val AllowReorder:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val LunchStart:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LunchDuration:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DebugRequestTime:String = null with get,set
        member val Debug:Boolean = new Boolean() with get,set

F# OptimizeScheduleRequest DTOs

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

HTTP + JSV

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

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

{
	Workspace: String,
	UserId: String,
	Date: String,
	TaskIds: 
	[
		String
	],
	RoundStartTimes: 0,
	TransitionTime: 0,
	StartTime: 0,
	StartLocation: 
	{
		y: 0,
		x: 0
	},
	EndLocation: 
	{
		y: 0,
		x: 0
	},
	AllowReorder: False,
	LunchStart: 0,
	LunchDuration: 0,
	DebugRequestTime: String,
	Debug: False
}