Field Squared API Services

<back to all web services

OptimizeScheduleRequest

The following routes are available for this service:
POST/{Workspace}/OptimizeSchedule
OptimizeScheduleRequest Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
UserIdbodystringNo
DatebodystringNo
TaskIdsbodyList<string>No
RoundStartTimesbodyintNo
TransitionTimebodyintNo
StartTimebodyint?No
StartLocationbodyLocationNo
EndLocationbodyLocationNo
AllowReorderbodybool?No
LunchStartbodyint?No
LunchDurationbodyint?No
DebugRequestTimebodystringNo
DebugbodyboolNo
Location Parameters:
NameParameterData TypeRequiredDescription
yformdoubleNo
xformdoubleNo

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
}