| GET,OPTIONS | /v1/dispatch/incidents |
|---|
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 DispatchIncidentMessageView:
message_id: int = 0
who: Optional[str] = None
role: Optional[str] = None
msg: Optional[str] = None
at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchIncidentView:
incident_id: int = 0
code: Optional[str] = None
kind: Optional[str] = None
kind_detail: Optional[str] = None
load_id: Optional[int] = None
load_code: Optional[str] = None
load_status: Optional[str] = None
source_label: Optional[str] = None
destination_label: Optional[str] = None
qty_text: Optional[str] = None
truck_code: Optional[str] = None
truck_label: Optional[str] = None
location_text: Optional[str] = None
lat: Optional[Decimal] = None
lng: Optional[Decimal] = None
driver_pref: Optional[str] = None
opened_by: Optional[str] = None
opened_via: Optional[str] = None
resolver: Optional[str] = None
status: Optional[str] = None
truck_recovery: Optional[str] = None
truck_recovered_utc: Optional[datetime.datetime] = None
load_recovery: Optional[str] = None
load_recovered_utc: Optional[datetime.datetime] = None
transload_truck_code: Optional[str] = None
hold_id: Optional[int] = None
hold_code: Optional[str] = None
photo_count: int = 0
opened_utc: datetime.datetime = datetime.datetime(1, 1, 1)
resolved_utc: Optional[datetime.datetime] = None
resolved_by: Optional[str] = None
reopened_utc: Optional[datetime.datetime] = None
messages: List[DispatchIncidentMessageView] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchIncidentTruckView:
code: Optional[str] = None
driver_name: Optional[str] = None
stage: Optional[str] = None
open_load_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchIncidentsResponse:
incidents: List[DispatchIncidentView] = field(default_factory=list)
empty_trucks: List[DispatchIncidentTruckView] = field(default_factory=list)
trucks: List[DispatchIncidentTruckView] = field(default_factory=list)
transload_truck_code: Optional[str] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchIncidentsRequest:
days: Optional[int] = None
Python DispatchIncidentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/dispatch/incidents HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DispatchIncidentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<EmptyTrucks>
<DispatchIncidentTruckView>
<Code>String</Code>
<DriverName>String</DriverName>
<OpenLoadCode>String</OpenLoadCode>
<Stage>String</Stage>
</DispatchIncidentTruckView>
</EmptyTrucks>
<Incidents>
<DispatchIncidentView>
<Code>String</Code>
<DestinationLabel>String</DestinationLabel>
<DriverPref>String</DriverPref>
<HoldCode>String</HoldCode>
<HoldId>0</HoldId>
<IncidentId>0</IncidentId>
<Kind>String</Kind>
<KindDetail>String</KindDetail>
<Lat>0</Lat>
<Lng>0</Lng>
<LoadCode>String</LoadCode>
<LoadId>0</LoadId>
<LoadRecoveredUtc>0001-01-01T00:00:00</LoadRecoveredUtc>
<LoadRecovery>String</LoadRecovery>
<LoadStatus>String</LoadStatus>
<LocationText>String</LocationText>
<Messages>
<DispatchIncidentMessageView>
<AtUtc>0001-01-01T00:00:00</AtUtc>
<MessageId>0</MessageId>
<Msg>String</Msg>
<Role>String</Role>
<Who>String</Who>
</DispatchIncidentMessageView>
</Messages>
<OpenedBy>String</OpenedBy>
<OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
<OpenedVia>String</OpenedVia>
<PhotoCount>0</PhotoCount>
<QtyText>String</QtyText>
<ReopenedUtc>0001-01-01T00:00:00</ReopenedUtc>
<ResolvedBy>String</ResolvedBy>
<ResolvedUtc>0001-01-01T00:00:00</ResolvedUtc>
<Resolver>String</Resolver>
<SourceLabel>String</SourceLabel>
<Status>String</Status>
<TransloadTruckCode>String</TransloadTruckCode>
<TruckCode>String</TruckCode>
<TruckLabel>String</TruckLabel>
<TruckRecoveredUtc>0001-01-01T00:00:00</TruckRecoveredUtc>
<TruckRecovery>String</TruckRecovery>
</DispatchIncidentView>
</Incidents>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<TransloadTruckCode>String</TransloadTruckCode>
<Trucks>
<DispatchIncidentTruckView>
<Code>String</Code>
<DriverName>String</DriverName>
<OpenLoadCode>String</OpenLoadCode>
<Stage>String</Stage>
</DispatchIncidentTruckView>
</Trucks>
</DispatchIncidentsResponse>