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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DispatchIncidentMessageRequest
            Public Overridable Property IncidentId As Integer
            Public Overridable Property Msg As String
        End Class

        Public Partial Class DispatchIncidentMessageView
            Public Overridable Property MessageId As Integer
            Public Overridable Property Who As String
            Public Overridable Property Role As String
            Public Overridable Property Msg As String
            Public Overridable Property AtUtc As Date
        End Class

        Public Partial Class DispatchIncidentsResponse
            Public Overridable Property Incidents As List(Of DispatchIncidentView) = New List(Of DispatchIncidentView)
            Public Overridable Property EmptyTrucks As List(Of DispatchIncidentTruckView) = New List(Of DispatchIncidentTruckView)
            Public Overridable Property Trucks As List(Of DispatchIncidentTruckView) = New List(Of DispatchIncidentTruckView)
            Public Overridable Property TransloadTruckCode As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DispatchIncidentTruckView
            Public Overridable Property Code As String
            Public Overridable Property DriverName As String
            Public Overridable Property Stage As String
            Public Overridable Property OpenLoadCode As String
        End Class

        Public Partial Class DispatchIncidentView
            Public Overridable Property IncidentId As Integer
            Public Overridable Property Code As String
            Public Overridable Property Kind As String
            Public Overridable Property KindDetail As String
            Public Overridable Property LoadId As Integer?
            Public Overridable Property LoadCode As String
            Public Overridable Property LoadStatus As String
            Public Overridable Property SourceLabel As String
            Public Overridable Property DestinationLabel As String
            Public Overridable Property QtyText As String
            Public Overridable Property TruckCode As String
            Public Overridable Property TruckLabel As String
            Public Overridable Property LocationText As String
            Public Overridable Property Lat As Decimal?
            Public Overridable Property Lng As Decimal?
            Public Overridable Property DriverPref As String
            Public Overridable Property OpenedBy As String
            Public Overridable Property OpenedVia As String
            Public Overridable Property Resolver As String
            Public Overridable Property Status As String
            Public Overridable Property TruckRecovery As String
            Public Overridable Property TruckRecoveredUtc As Date?
            Public Overridable Property LoadRecovery As String
            Public Overridable Property LoadRecoveredUtc As Date?
            Public Overridable Property TransloadTruckCode As String
            Public Overridable Property HoldId As Integer?
            Public Overridable Property HoldCode As String
            Public Overridable Property PhotoCount As Integer
            Public Overridable Property OpenedUtc As Date
            Public Overridable Property ResolvedUtc As Date?
            Public Overridable Property ResolvedBy As String
            Public Overridable Property ReopenedUtc As Date?
            Public Overridable Property Messages As List(Of DispatchIncidentMessageView) = New List(Of DispatchIncidentMessageView)
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}