Trendsic Platform Service

<back to all web services

DispatchIncidentMessageRequest

Requires Authentication
Requires any of the permissions:DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/incidents/{IncidentId}/message
import Foundation
import ServiceStack

public class DispatchIncidentMessageRequest : Codable
{
    public var incidentId:Int
    public var msg:String

    required public init(){}
}

public class DispatchIncidentsResponse : Codable
{
    public var incidents:[DispatchIncidentView] = []
    public var emptyTrucks:[DispatchIncidentTruckView] = []
    public var trucks:[DispatchIncidentTruckView] = []
    public var transloadTruckCode:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DispatchIncidentView : Codable
{
    public var incidentId:Int
    public var code:String
    public var kind:String
    public var kindDetail:String
    public var loadId:Int?
    public var loadCode:String
    public var loadStatus:String
    public var sourceLabel:String
    public var destinationLabel:String
    public var qtyText:String
    public var truckCode:String
    public var truckLabel:String
    public var locationText:String
    public var lat:Double?
    public var lng:Double?
    public var driverPref:String
    public var openedBy:String
    public var openedVia:String
    public var resolver:String
    public var status:String
    public var truckRecovery:String
    public var truckRecoveredUtc:Date?
    public var loadRecovery:String
    public var loadRecoveredUtc:Date?
    public var transloadTruckCode:String
    public var holdId:Int?
    public var holdCode:String
    public var photoCount:Int
    public var openedUtc:Date
    public var resolvedUtc:Date?
    public var resolvedBy:String
    public var reopenedUtc:Date?
    public var messages:[DispatchIncidentMessageView] = []

    required public init(){}
}

public class DispatchIncidentMessageView : Codable
{
    public var messageId:Int
    public var who:String
    public var role:String
    public var msg:String
    public var atUtc:Date

    required public init(){}
}

public class DispatchIncidentTruckView : Codable
{
    public var code:String
    public var driverName:String
    public var stage:String
    public var openLoadCode:String

    required public init(){}
}


Swift DispatchIncidentMessageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchIncidentMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <IncidentId>0</IncidentId>
  <Msg>String</Msg>
</DispatchIncidentMessageRequest>
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>