| POST | /{Workspace}/ProposeRoute |
|---|
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 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 Location:
y: float = 0.0
x: float = 0.0
@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 ProposeRouteRequest:
workspace: Optional[str] = None
nodes: Optional[List[RouteNode]] = None
allow_reorder: bool = False
start_location: Optional[Location] = None
end_location: Optional[Location] = None
shortest_distance: bool = False
start_time: Optional[str] = None
start_clock_at_first_node: bool = False
round_start_times: int = 0
transition_time: int = 0
lunch_start: Optional[str] = None
lunch_duration: int = 0
time: int = 0
real_time: int = 0
distance: float = 0.0
Python ProposeRouteRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"Workspace":"String","Nodes":[{"Location":{"y":0,"x":0},"StopTime":0,"Schedule":{"Workspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","Start":"String","End":"String","TimeZone":"String","Users":["String"],"Teams":["String"],"Data":{"String":{}}},"Name":"String","ObjectId":"String","Class":"String","VersionId":"String","Ancestors":["String"],"Type":"String"}],"AllowReorder":false,"StartLocation":{"y":0,"x":0},"EndLocation":{"y":0,"x":0},"ShortestDistance":false,"StartTime":"String","StartClockAtFirstNode":false,"RoundStartTimes":0,"TransitionTime":0,"LunchStart":"String","LunchDuration":0,"Time":0,"RealTime":0,"Distance":0}