| GET,OPTIONS | /v1/dispatch/courier/vans |
|---|
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 CourierMoveTarget:
driver_contact_id: int = 0
name: Optional[str] = None
ok: bool = False
why: Optional[str] = None
leave_by_text: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierVanChip:
code: Optional[str] = None
courier_step: Optional[str] = None
level_code: Optional[str] = None
level_name: Optional[str] = None
units: int = 0
area: Optional[str] = None
due_utc: Optional[datetime.datetime] = None
due_text: Optional[str] = None
movable: bool = False
no_move_why: Optional[str] = None
targets: List[CourierMoveTarget] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierOfficeVan:
driver_contact_id: int = 0
driver_code: Optional[str] = None
name: Optional[str] = None
online: bool = False
zone: Optional[str] = None
vehicle_unit: Optional[str] = None
facility_name: Optional[str] = None
state: Optional[str] = None
leave_by_utc: Optional[datetime.datetime] = None
leave_by_text: Optional[str] = None
slack_min: Optional[int] = None
in_van: int = 0
committed: int = 0
cap: Optional[Decimal] = None
cap_unit: Optional[str] = None
unit_many: Optional[str] = None
critical_code: Optional[str] = None
drive_min: int = 0
send_note: Optional[str] = None
aboard: List[CourierVanChip] = field(default_factory=list)
queued: List[CourierVanChip] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierHeldView:
code: Optional[str] = None
area: Optional[str] = None
units: int = 0
unit_many: Optional[str] = None
miles: Optional[Decimal] = None
level_code: Optional[str] = None
level_name: Optional[str] = None
due_text: Optional[str] = None
held_reason: Optional[str] = None
held_min: Optional[int] = None
why: List[str] = field(default_factory=list)
best_driver_contact_id: Optional[int] = None
best_name: Optional[str] = None
best_leave_by_text: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierVehicleOption:
courier_profile_id: int = 0
equipment_i_d: int = 0
unit_number: Optional[str] = None
vehicle_type: Optional[str] = None
capacity_unit: Optional[str] = None
capacity_limit: Optional[Decimal] = None
is_refrigerated: bool = False
status: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierFacilityOption:
courier_facility_i_d: int = 0
code: Optional[str] = None
name: Optional[str] = None
address: Optional[str] = None
intake_min: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierProfileOption:
courier_profile_i_d: int = 0
name: Optional[str] = None
route_shape: Optional[str] = None
enabled: bool = False
unit_one: Optional[str] = None
unit_many: Optional[str] = None
facility_noun: Optional[str] = None
facilities: List[CourierFacilityOption] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverOption:
contact_id: int = 0
code: Optional[str] = None
name: Optional[str] = None
online: bool = False
zone: Optional[str] = None
vehicle_unit: Optional[str] = None
equipment_i_d: Optional[int] = None
sent_to_facility: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDeskRow:
code: Optional[str] = None
courier_profile_id: int = 0
facility_name: Optional[str] = None
level_code: Optional[str] = None
level_name: Optional[str] = None
due_utc: Optional[datetime.datetime] = None
due_text: Optional[str] = None
units: int = 0
units_found: Optional[int] = None
unit_many: Optional[str] = None
fare: Optional[Decimal] = None
final_price: Optional[Decimal] = None
tip_amount: Optional[Decimal] = None
pay_mode: Optional[str] = None
capture_mode: Optional[str] = None
customer_name: Optional[str] = None
area: Optional[str] = None
intake_utc: Optional[datetime.datetime] = None
intake_min_ago: Optional[int] = None
damage_note: Optional[str] = None
final_price_after_count: bool = False
needs_price: bool = False
item_count: int = 0
missing_count: int = 0
photo_count: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierOfficeView:
server_utc: datetime.datetime = datetime.datetime(1, 1, 1)
vans: List[CourierOfficeVan] = field(default_factory=list)
held: List[CourierHeldView] = field(default_factory=list)
vehicles: List[CourierVehicleOption] = field(default_factory=list)
profiles: List[CourierProfileOption] = field(default_factory=list)
drivers: List[CourierDriverOption] = field(default_factory=list)
desk: List[CourierDeskRow] = field(default_factory=list)
go_count: int = 0
held_count: int = 0
ready_to_offer: int = 0
intake_min: Optional[int] = None
facility_noun: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierOfficeResponse:
office: Optional[CourierOfficeView] = None
available: bool = False
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierVansRequest:
pass
Python CourierVansRequest 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.
GET /v1/dispatch/courier/vans HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Office:
{
ServerUtc: 0001-01-01,
Vans:
[
{
DriverContactId: 0,
DriverCode: String,
Name: String,
Online: False,
Zone: String,
VehicleUnit: String,
FacilityName: String,
State: String,
LeaveByUtc: 0001-01-01,
LeaveByText: String,
SlackMin: 0,
InVan: 0,
Committed: 0,
Cap: 0,
CapUnit: String,
UnitMany: String,
CriticalCode: String,
DriveMin: 0,
SendNote: String,
Aboard:
[
{
Code: String,
CourierStep: String,
LevelCode: String,
LevelName: String,
Units: 0,
Area: String,
DueUtc: 0001-01-01,
DueText: String,
Movable: False,
NoMoveWhy: String,
Targets:
[
{
DriverContactId: 0,
Name: String,
Ok: False,
Why: String,
LeaveByText: String
}
]
}
],
Queued:
[
{
Code: String,
CourierStep: String,
LevelCode: String,
LevelName: String,
Units: 0,
Area: String,
DueUtc: 0001-01-01,
DueText: String,
Movable: False,
NoMoveWhy: String,
Targets:
[
{
DriverContactId: 0,
Name: String,
Ok: False,
Why: String,
LeaveByText: String
}
]
}
]
}
],
Held:
[
{
Code: String,
Area: String,
Units: 0,
UnitMany: String,
Miles: 0,
LevelCode: String,
LevelName: String,
DueText: String,
HeldReason: String,
HeldMin: 0,
Why:
[
String
],
BestDriverContactId: 0,
BestName: String,
BestLeaveByText: String
}
],
Vehicles:
[
{
CourierProfileId: 0,
EquipmentID: 0,
UnitNumber: String,
VehicleType: String,
CapacityUnit: String,
CapacityLimit: 0,
IsRefrigerated: False,
Status: String
}
],
Profiles:
[
{
CourierProfileID: 0,
Name: String,
RouteShape: String,
Enabled: False,
UnitOne: String,
UnitMany: String,
FacilityNoun: String,
Facilities:
[
{
CourierFacilityID: 0,
Code: String,
Name: String,
Address: String,
IntakeMin: 0
}
]
}
],
Drivers:
[
{
ContactId: 0,
Code: String,
Name: String,
Online: False,
Zone: String,
VehicleUnit: String,
EquipmentID: 0,
SentToFacility: False
}
],
Desk:
[
{
Code: String,
CourierProfileId: 0,
FacilityName: String,
LevelCode: String,
LevelName: String,
DueUtc: 0001-01-01,
DueText: String,
Units: 0,
UnitsFound: 0,
UnitMany: String,
Fare: 0,
FinalPrice: 0,
TipAmount: 0,
PayMode: String,
CaptureMode: String,
CustomerName: String,
Area: String,
IntakeUtc: 0001-01-01,
IntakeMinAgo: 0,
DamageNote: String,
FinalPriceAfterCount: False,
NeedsPrice: False,
ItemCount: 0,
MissingCount: 0,
PhotoCount: 0
}
],
GoCount: 0,
HeldCount: 0,
ReadyToOffer: 0,
IntakeMin: 0,
FacilityNoun: String
},
Available: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}