| Requires any of the permissions: | DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE |
| POST,OPTIONS | /v1/dispatch/incidents/{IncidentId}/message |
|---|
export class DispatchIncidentMessageView
{
public MessageId: number;
public Who: string;
public Role: string;
public Msg: string;
public AtUtc: string;
public constructor(init?: Partial<DispatchIncidentMessageView>) { (Object as any).assign(this, init); }
}
export class DispatchIncidentView
{
public IncidentId: number;
public Code: string;
public Kind: string;
public KindDetail: string;
public LoadId?: number;
public LoadCode: string;
public LoadStatus: string;
public SourceLabel: string;
public DestinationLabel: string;
public QtyText: string;
public TruckCode: string;
public TruckLabel: string;
public LocationText: string;
public Lat?: number;
public Lng?: number;
public DriverPref: string;
public OpenedBy: string;
public OpenedVia: string;
public Resolver: string;
public Status: string;
public TruckRecovery: string;
public TruckRecoveredUtc?: string;
public LoadRecovery: string;
public LoadRecoveredUtc?: string;
public TransloadTruckCode: string;
public HoldId?: number;
public HoldCode: string;
public PhotoCount: number;
public OpenedUtc: string;
public ResolvedUtc?: string;
public ResolvedBy: string;
public ReopenedUtc?: string;
public Messages: DispatchIncidentMessageView[] = [];
public constructor(init?: Partial<DispatchIncidentView>) { (Object as any).assign(this, init); }
}
export class DispatchIncidentTruckView
{
public Code: string;
public DriverName: string;
public Stage: string;
public OpenLoadCode: string;
public constructor(init?: Partial<DispatchIncidentTruckView>) { (Object as any).assign(this, init); }
}
export class DispatchIncidentsResponse
{
public Incidents: DispatchIncidentView[] = [];
public EmptyTrucks: DispatchIncidentTruckView[] = [];
public Trucks: DispatchIncidentTruckView[] = [];
public TransloadTruckCode: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<DispatchIncidentsResponse>) { (Object as any).assign(this, init); }
}
export class DispatchIncidentMessageRequest
{
public IncidentId: number;
public Msg: string;
public constructor(init?: Partial<DispatchIncidentMessageRequest>) { (Object as any).assign(this, init); }
}
TypeScript DispatchIncidentMessageRequest 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.
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>