Field Squared API Services

<back to all web services

DriveTimeBatch

The following routes are available for this service:
POST/{Workspace}/DriveTimeBatch
DriveTimeBatch Parameters:
NameParameterData TypeRequiredDescription
DriveTimesbodyList<DriveTime>No
WorkspacepathstringNo
DriveTime Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
StartLocformLocationNo
EndLocformLocationNo
DurationformdoubleNo
DistanceformdoubleNo
ErrorformstringNo
UserIdformstringNo
EndScheduleIdformstringNo
TimeBetweenSchedulesformintNo
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}/DriveTimeBatch HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DriveTimeBatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Geocoding">
  <DriveTimes>
    <DriveTime>
      <Distance>0</Distance>
      <Duration>0</Duration>
      <EndLoc xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:x>0</d4p1:x>
        <d4p1:y>0</d4p1:y>
      </EndLoc>
      <EndScheduleId>String</EndScheduleId>
      <Error>String</Error>
      <StartLoc xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:x>0</d4p1:x>
        <d4p1:y>0</d4p1:y>
      </StartLoc>
      <TimeBetweenSchedules>0</TimeBetweenSchedules>
      <UserId>String</UserId>
      <Workspace>String</Workspace>
    </DriveTime>
  </DriveTimes>
  <Workspace>String</Workspace>
</DriveTimeBatch>