| Requires any of the permissions: | DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE |
| POST,OPTIONS | /v1/dispatch/incidents/{IncidentId}/message |
|---|
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 DispatchIncidentMessageRequest:
incident_id: int = 0
msg: Optional[str] = None
Python DispatchIncidentMessageRequest 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/dispatch/incidents/{IncidentId}/message HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IncidentId: 0,
Msg: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Incidents:
[
{
IncidentId: 0,
Code: String,
Kind: String,
KindDetail: String,
LoadId: 0,
LoadCode: String,
LoadStatus: String,
SourceLabel: String,
DestinationLabel: String,
QtyText: String,
TruckCode: String,
TruckLabel: String,
LocationText: String,
Lat: 0,
Lng: 0,
DriverPref: String,
OpenedBy: String,
OpenedVia: String,
Resolver: String,
Status: String,
TruckRecovery: String,
TruckRecoveredUtc: 0001-01-01,
LoadRecovery: String,
LoadRecoveredUtc: 0001-01-01,
TransloadTruckCode: String,
HoldId: 0,
HoldCode: String,
PhotoCount: 0,
OpenedUtc: 0001-01-01,
ResolvedUtc: 0001-01-01,
ResolvedBy: String,
ReopenedUtc: 0001-01-01,
Messages:
[
{
MessageId: 0,
Who: String,
Role: String,
Msg: String,
AtUtc: 0001-01-01
}
]
}
],
EmptyTrucks:
[
{
Code: String,
DriverName: String,
Stage: String,
OpenLoadCode: String
}
],
Trucks:
[
{
Code: String,
DriverName: String,
Stage: String,
OpenLoadCode: String
}
],
TransloadTruckCode: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}