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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DispatchIncidentMessageView() = 
        member val MessageId:Int32 = new Int32() with get,set
        member val Who:String = null with get,set
        member val Role:String = null with get,set
        member val Msg:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type DispatchIncidentView() = 
        member val IncidentId:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Kind:String = null with get,set
        member val KindDetail:String = null with get,set
        member val LoadId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LoadCode:String = null with get,set
        member val LoadStatus:String = null with get,set
        member val SourceLabel:String = null with get,set
        member val DestinationLabel:String = null with get,set
        member val QtyText:String = null with get,set
        member val TruckCode:String = null with get,set
        member val TruckLabel:String = null with get,set
        member val LocationText:String = null with get,set
        member val Lat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Lng:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val DriverPref:String = null with get,set
        member val OpenedBy:String = null with get,set
        member val OpenedVia:String = null with get,set
        member val Resolver:String = null with get,set
        member val Status:String = null with get,set
        member val TruckRecovery:String = null with get,set
        member val TruckRecoveredUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LoadRecovery:String = null with get,set
        member val LoadRecoveredUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TransloadTruckCode:String = null with get,set
        member val HoldId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HoldCode:String = null with get,set
        member val PhotoCount:Int32 = new Int32() with get,set
        member val OpenedUtc:DateTime = new DateTime() with get,set
        member val ResolvedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ResolvedBy:String = null with get,set
        member val ReopenedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Messages:ResizeArray<DispatchIncidentMessageView> = new ResizeArray<DispatchIncidentMessageView>() with get,set

    [<AllowNullLiteral>]
    type DispatchIncidentTruckView() = 
        member val Code:String = null with get,set
        member val DriverName:String = null with get,set
        member val Stage:String = null with get,set
        member val OpenLoadCode:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchIncidentsResponse() = 
        member val Incidents:ResizeArray<DispatchIncidentView> = new ResizeArray<DispatchIncidentView>() with get,set
        member val EmptyTrucks:ResizeArray<DispatchIncidentTruckView> = new ResizeArray<DispatchIncidentTruckView>() with get,set
        member val Trucks:ResizeArray<DispatchIncidentTruckView> = new ResizeArray<DispatchIncidentTruckView>() with get,set
        member val TransloadTruckCode:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchIncidentMessageRequest() = 
        member val IncidentId:Int32 = new Int32() with get,set
        member val Msg:String = null with get,set

F# DispatchIncidentMessageRequest DTOs

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

HTTP + 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
		}
	}
}