Field Squared API Services

DriveTimeBatch

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

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 DriveTime:
    workspace: Optional[str] = None
    start_loc: Optional[Location] = None
    end_loc: Optional[Location] = None
    duration: float = 0.0
    distance: float = 0.0
    error: Optional[str] = None
    user_id: Optional[str] = None
    end_schedule_id: Optional[str] = None
    time_between_schedules: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriveTimeBatch:
    drive_times: Optional[List[DriveTime]] = None
    workspace: Optional[str] = None

Python DriveTimeBatch DTOs

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>