Field Squared API Services

<back to all web services

OptimizeScheduleRequest

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

export class Location
{
    public y: number;
    public x: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class OptimizeScheduleRequest
{
    public Workspace: string;
    public UserId: string;
    public Date: string;
    public TaskIds: string[];
    public RoundStartTimes: number;
    public TransitionTime: number;
    public StartTime?: number;
    public StartLocation: Location;
    public EndLocation: Location;
    public AllowReorder?: boolean;
    public LunchStart?: number;
    public LunchDuration?: number;
    public DebugRequestTime: string;
    public Debug: boolean;

    public constructor(init?: Partial<OptimizeScheduleRequest>) { (Object as any).assign(this, init); }
}

TypeScript OptimizeScheduleRequest 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}/OptimizeSchedule HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
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}