Field Squared API Services

ProposeRouteRequest

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

**ProposeRouteRequest** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
Nodes	body	List<RouteNode>	No
AllowReorder	body	bool	No
StartLocation	body	Location	No
EndLocation	body	Location	No
ShortestDistance	body	bool	No
StartTime	body	string	No
StartClockAtFirstNode	body	bool	No
RoundStartTimes	body	int	No
TransitionTime	body	int	No
LunchStart	body	string	No
LunchDuration	body	int	No
Time	body	int	No
RealTime	body	int	No
Distance	body	double	No

**RouteNode** Parameters:
Name	Parameter	Data Type	Required
Location	form	Location	No
StopTime	form	int	No
Schedule	form	Schedule	No
Name	form	string	No

**ClassedItem** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Class	form	string	No
VersionId	form	string	No
Ancestors	form	List<string>	No
Type	form	string	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
y	form	double	No
x	form	double	No

**Schedule** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
BasedOn	form	string	No
Start	form	string	No
End	form	string	No
TimeZone	form	string	No
Users	form	List<string>	No
Teams	form	List<string>	No
Data	form	Dictionary<string, Object>	No

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}/ProposeRoute HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProposeRouteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.MapRoute">
  <AllowReorder>false</AllowReorder>
  <Distance>0</Distance>
  <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>String</LunchStart>
  <Nodes>
    <RouteNode>
      <Ancestors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
        <d4p1:string>String</d4p1:string>
      </Ancestors>
      <Class xmlns="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">String</Class>
      <ObjectId xmlns="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">String</ObjectId>
      <Type xmlns="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">String</Type>
      <VersionId xmlns="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">String</VersionId>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:x>0</d4p1:x>
        <d4p1:y>0</d4p1:y>
      </Location>
      <Name>String</Name>
      <Schedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Schedules">
        <d4p1:BasedOn>String</d4p1:BasedOn>
        <d4p1:Data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d4p1:Data>
        <d4p1:End>String</d4p1:End>
        <d4p1:ObjectId>String</d4p1:ObjectId>
        <d4p1:Start>String</d4p1:Start>
        <d4p1:Teams xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d4p1:Teams>
        <d4p1:TimeZone>String</d4p1:TimeZone>
        <d4p1:Users xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d4p1:Users>
        <d4p1:VersionId>String</d4p1:VersionId>
        <d4p1:Workspace>String</d4p1:Workspace>
      </Schedule>
      <StopTime>0</StopTime>
    </RouteNode>
  </Nodes>
  <RealTime>0</RealTime>
  <RoundStartTimes>0</RoundStartTimes>
  <ShortestDistance>false</ShortestDistance>
  <StartClockAtFirstNode>false</StartClockAtFirstNode>
  <StartLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:x>0</d2p1:x>
    <d2p1:y>0</d2p1:y>
  </StartLocation>
  <StartTime>String</StartTime>
  <Time>0</Time>
  <TransitionTime>0</TransitionTime>
  <Workspace>String</Workspace>
</ProposeRouteRequest>