| POST,OPTIONS | /v1/dashboard/dispatch |
|---|
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 DashboardStatTile:
key: Optional[str] = None
label: Optional[str] = None
value: float = 0.0
previous_value: Optional[float] = None
unit: Optional[str] = None
delta_pct: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportDayRow:
label: Optional[str] = None
loads: int = 0
revenue: float = 0.0
pay: float = 0.0
qty: float = 0.0
avg_cycle_mins: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportModuleRow:
module: Optional[str] = None
loads: int = 0
qty: float = 0.0
revenue: float = 0.0
pay: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportLaneRow:
supplier_name: Optional[str] = None
source_label: Optional[str] = None
loads: int = 0
qty: float = 0.0
revenue: float = 0.0
avg_cycle_mins: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportTruckRow:
truck_label: Optional[str] = None
driver_label: Optional[str] = None
loads: int = 0
qty: float = 0.0
revenue: float = 0.0
pay: float = 0.0
avg_cycle_mins: Optional[float] = None
days_active: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportDriverRow:
driver: Optional[str] = None
driver_contact_id: Optional[int] = None
loads: int = 0
qty: float = 0.0
pay: float = 0.0
days_active: int = 0
unpriced: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportJobRow:
job_code: Optional[str] = None
customer: Optional[str] = None
cargo: Optional[str] = None
route: Optional[str] = None
miles: int = 0
revenue: Optional[float] = None
pay: Optional[float] = None
margin_pct: Optional[float] = None
closed_utc: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportIncidentRow:
kind: Optional[str] = None
opened: int = 0
resolved: int = 0
avg_resolve_mins: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportHoldRow:
scope_kind: Optional[str] = None
holds: int = 0
paused_mins: int = 0
weather: int = 0
from_incidents: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportResponse:
stats: List[DashboardStatTile] = field(default_factory=list)
unit: Optional[str] = None
trend: List[DispatchReportDayRow] = field(default_factory=list)
by_module: List[DispatchReportModuleRow] = field(default_factory=list)
by_lane: List[DispatchReportLaneRow] = field(default_factory=list)
by_truck: List[DispatchReportTruckRow] = field(default_factory=list)
by_driver: List[DispatchReportDriverRow] = field(default_factory=list)
jobs: List[DispatchReportJobRow] = field(default_factory=list)
incidents: List[DispatchReportIncidentRow] = field(default_factory=list)
holds: List[DispatchReportHoldRow] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchReportRequest:
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
location_ids: List[str] = field(default_factory=list)
Python DispatchReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dashboard/dispatch HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromDate: 0001-01-01,
ToDate: 0001-01-01,
LocationIds:
[
00000000000000000000000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Stats:
[
{
Key: String,
Label: String,
Value: 0,
PreviousValue: 0,
Unit: String
}
],
Unit: String,
Trend:
[
{
Label: String,
Loads: 0,
Revenue: 0,
Pay: 0,
Qty: 0,
AvgCycleMins: 0
}
],
ByModule:
[
{
Module: String,
Loads: 0,
Qty: 0,
Revenue: 0,
Pay: 0
}
],
ByLane:
[
{
SupplierName: String,
SourceLabel: String,
Loads: 0,
Qty: 0,
Revenue: 0,
AvgCycleMins: 0
}
],
ByTruck:
[
{
TruckLabel: String,
DriverLabel: String,
Loads: 0,
Qty: 0,
Revenue: 0,
Pay: 0,
AvgCycleMins: 0,
DaysActive: 0
}
],
ByDriver:
[
{
Driver: String,
DriverContactId: 0,
Loads: 0,
Qty: 0,
Pay: 0,
DaysActive: 0,
Unpriced: 0
}
],
Jobs:
[
{
JobCode: String,
Customer: String,
Cargo: String,
Route: String,
Miles: 0,
Revenue: 0,
Pay: 0,
MarginPct: 0,
ClosedUtc: 0001-01-01
}
],
Incidents:
[
{
Kind: String,
Opened: 0,
Resolved: 0,
AvgResolveMins: 0
}
],
Holds:
[
{
ScopeKind: String,
Holds: 0,
PausedMins: 0,
Weather: 0,
FromIncidents: 0
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}