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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<OptimizeScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.MapRoute">
  <AllowReorder>false</AllowReorder>
  <Date>String</Date>
  <Debug>false</Debug>
  <DebugRequestTime>String</DebugRequestTime>
  <EndLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:x>0</d2p1:x>
    <d2p1:y>0</d2p1:y>
  </EndLocation>
  <LunchDuration>0</LunchDuration>
  <LunchStart>0</LunchStart>
  <RoundStartTimes>0</RoundStartTimes>
  <StartLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:x>0</d2p1:x>
    <d2p1:y>0</d2p1:y>
  </StartLocation>
  <StartTime>0</StartTime>
  <TaskIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TaskIds>
  <TransitionTime>0</TransitionTime>
  <UserId>String</UserId>
  <Workspace>String</Workspace>
</OptimizeScheduleRequest>