Field Squared API Services

OptimizeScheduleRequest

The following routes are available for this service:
POST	/{Workspace}/OptimizeSchedule

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Location:
    y: float = 0.0
    x: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OptimizeScheduleRequest:
    workspace: Optional[str] = None
    user_id: Optional[str] = None
    date: Optional[str] = None
    task_ids: Optional[List[str]] = None
    round_start_times: int = 0
    transition_time: int = 0
    start_time: Optional[int] = None
    start_location: Optional[Location] = None
    end_location: Optional[Location] = None
    allow_reorder: Optional[bool] = None
    lunch_start: Optional[int] = None
    lunch_duration: Optional[int] = None
    debug_request_time: Optional[str] = None
    debug: bool = False

Python 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
}