| Requires any of the permissions: | DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE |
| POST,OPTIONS | /v1/dispatch/incidents |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Kind | body | string | No | |
| KindDetail | body | string | No | |
| TruckCode | body | string | No | |
| LoadCode | body | string | No | |
| LocationText | body | string | No | |
| Lat | body | decimal? | No | |
| Lng | body | decimal? | No | |
| DriverPref | body | string | No | |
| Note | body | string | No | |
| OpenedBy | body | string | No | |
| OpenedVia | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Incidents | form | List<DispatchIncidentView> | No | |
| EmptyTrucks | form | List<DispatchIncidentTruckView> | No | |
| Trucks | form | List<DispatchIncidentTruckView> | No | |
| TransloadTruckCode | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncidentId | form | int | No | |
| Code | form | string | No | |
| Kind | form | string | No | |
| KindDetail | form | string | No | |
| LoadId | form | int? | No | |
| LoadCode | form | string | No | |
| LoadStatus | form | string | No | |
| SourceLabel | form | string | No | |
| DestinationLabel | form | string | No | |
| QtyText | form | string | No | |
| TruckCode | form | string | No | |
| TruckLabel | form | string | No | |
| LocationText | form | string | No | |
| Lat | form | decimal? | No | |
| Lng | form | decimal? | No | |
| DriverPref | form | string | No | |
| OpenedBy | form | string | No | |
| OpenedVia | form | string | No | |
| Resolver | form | string | No | |
| Status | form | string | No | |
| TruckRecovery | form | string | No | |
| TruckRecoveredUtc | form | DateTime? | No | |
| LoadRecovery | form | string | No | |
| LoadRecoveredUtc | form | DateTime? | No | |
| TransloadTruckCode | form | string | No | |
| HoldId | form | int? | No | |
| HoldCode | form | string | No | |
| PhotoCount | form | int | No | |
| OpenedUtc | form | DateTime | No | |
| ResolvedUtc | form | DateTime? | No | |
| ResolvedBy | form | string | No | |
| ReopenedUtc | form | DateTime? | No | |
| Messages | form | List<DispatchIncidentMessageView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MessageId | form | int | No | |
| Who | form | string | No | |
| Role | form | string | No | |
| Msg | form | string | No | |
| AtUtc | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| DriverName | form | string | No | |
| Stage | form | string | No | |
| OpenLoadCode | form | string | No |
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 HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Kind: String,
KindDetail: String,
TruckCode: String,
LoadCode: String,
LocationText: String,
Lat: 0,
Lng: 0,
DriverPref: String,
Note: String,
OpenedBy: String,
OpenedVia: 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
}
}
}