Field Squared API Services

Route

Contains the data for a route within the system.

The following routes are available for this service:
GET,POST,DELETE	/{Workspace}/Route/{ObjectId}
GET	/{Workspace}/Route/{UserId}/{Date}

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 ClassedItem:
    object_id: Optional[str] = None
    class_: Optional[str] = field(metadata=config(field_name='class'), default=None)
    version_id: Optional[str] = None
    ancestors: Optional[List[str]] = None
    type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Schedule:
    workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    based_on: Optional[str] = None
    start: Optional[str] = None
    end: Optional[str] = None
    time_zone: Optional[str] = None
    users: Optional[List[str]] = None
    teams: Optional[List[str]] = None
    data: Optional[Dict[str, Object]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RouteNode(ClassedItem):
    location: Optional[Location] = None
    stop_time: int = 0
    schedule: Optional[Schedule] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RouteSegment:
    time: int = 0
    distance: float = 0.0
    start: Optional[str] = None
    end: Optional[str] = None
    geometry: Optional[List[Location]] = None
    driving_directions: Optional[List[str]] = None
    end_node: Optional[RouteNode] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Route:
    """
    Contains the data for a route within the system.
    """

    workspace: Optional[str] = None
    assigned_workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    based_on: Optional[str] = None
    created: Optional[str] = None
    last_updated: Optional[str] = None
    date: Optional[str] = None
    start_time: Optional[str] = None
    end_time: Optional[str] = None
    user_id: Optional[str] = None
    name: Optional[str] = None
    type: Optional[str] = None
    segments: Optional[List[RouteSegment]] = None
    total_time: int = 0
    total_distance: float = 0.0
    nodes: Optional[List[RouteNode]] = None

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

<Route xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.MapRoute">
  <AssignedWorkspace>String</AssignedWorkspace>
  <BasedOn>String</BasedOn>
  <Created>String</Created>
  <Date>String</Date>
  <EndTime>String</EndTime>
  <LastUpdated>String</LastUpdated>
  <Name>String</Name>
  <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>
  <ObjectId>String</ObjectId>
  <Segments>
    <RouteSegment>
      <Distance>0</Distance>
      <DrivingDirections xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </DrivingDirections>
      <End>String</End>
      <EndNode>
        <Ancestors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
          <d5p1:string>String</d5p1: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:d5p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
          <d5p1:x>0</d5p1:x>
          <d5p1:y>0</d5p1:y>
        </Location>
        <Name>String</Name>
        <Schedule xmlns:d5p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Schedules">
          <d5p1:BasedOn>String</d5p1:BasedOn>
          <d5p1:Data xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringanyType>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value />
            </d6p1:KeyValueOfstringanyType>
          </d5p1:Data>
          <d5p1:End>String</d5p1:End>
          <d5p1:ObjectId>String</d5p1:ObjectId>
          <d5p1:Start>String</d5p1:Start>
          <d5p1:Teams xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d5p1:Teams>
          <d5p1:TimeZone>String</d5p1:TimeZone>
          <d5p1:Users xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d5p1:Users>
          <d5p1:VersionId>String</d5p1:VersionId>
          <d5p1:Workspace>String</d5p1:Workspace>
        </Schedule>
        <StopTime>0</StopTime>
      </EndNode>
      <Geometry xmlns:d4p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
        <d4p1:Location>
          <d4p1:x>0</d4p1:x>
          <d4p1:y>0</d4p1:y>
        </d4p1:Location>
      </Geometry>
      <Start>String</Start>
      <Time>0</Time>
    </RouteSegment>
  </Segments>
  <StartTime>String</StartTime>
  <Type>String</Type>
  <UserId>String</UserId>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</Route>