Trendsic Platform Service

DriverIncidentOpenRequest

The following routes are available for this service:
POST,OPTIONS	/v1/worker/dispatch/incident

import Foundation
import ServiceStack

public class DriverIncidentOpenRequest : Codable
{
    public var kind:String
    public var kindDetail:String
    public var note:String
    public var driverPref:String
    public var locationText:String
    public var lat:Double?
    public var lng:Double?
    public var photoCount:Int

    required public init(){}
}

public class DriverMeResponse : Codable
{
    public var contactId:Int
    public var name:String
    public var phone:String
    public var payPlanName:String
    public var payPlanBasis:String
    public var payPlanRate:Double?
    public var truck:DriverTruckView
    public var rig:DriverRigView
    public var jobs:[DriverJobView] = []
    public var od:DriverOdView
    public var incidents:[DriverIncidentView] = []
    public var pay:[DriverPayLineView] = []
    public var serverUtc:Date
    public var message:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DriverTruckView : Codable
{
    public var code:String
    public var stage:String
    public var stageSinceUtc:Date?
    public var loadsToday:Int
    public var netToday:Double
    public var estLoad:Double?
    public var slot:String
    public var siteName:String
    public var supplierName:String
    public var nextSiteName:String
    public var facility:String
    public var facilityShort:String
    public var unit:String
    public var queuePosition:Int?
    public var holdCode:String
    public var holdReason:String
    public var holdEndUtc:Date?
    public var openLoadId:Int?
    public var openLoadCode:String
    public var openLoadPhotos:Int
    public var stamps:[DriverStampView] = []

    required public init(){}
}

public class DriverStampView : Codable
{
    public var stage:String
    public var atUtc:Date
    public var note:String

    required public init(){}
}

public class DriverRigView : Codable
{
    public var code:String
    public var name:String
    public var rigType:String
    public var isFree:Bool
    public var holdCode:String
    public var holdReason:String
    public var holdEndUtc:Date?

    required public init(){}
}

public class DriverJobView : Codable
{
    public var kind:String
    public var code:String
    public var cargo:String
    public var customer:String
    public var customerPhone:String
    public var holdContact:String
    public var holdPhone:String
    public var fromLoc:String
    public var toLoc:String
    public var miles:Int
    public var windowText:String
    public var stage:String
    public var rate:Double?
    public var requiredRig:String
    public var etaText:String
    public var offerExpiresUtc:Date?
    public var requestId:Int?
    public var loadId:Int?
    public var loadCode:String
    public var loadPay:Double?
    public var photos:Int
    public var stamps:[DriverStampView] = []

    required public init(){}
}

public class DriverOdView : Codable
{
    public var code:String
    public var name:String
    public var zone:String
    public var status:String
    public var tier:String
    public var capabilities:String
    public var pingCode:String
    public var pingAddress:String
    public var pingZone:String
    public var pingBags:Int?
    public var pingNeeds:String
    public var pingNote:String
    public var pingExpiresUtc:Date?
    public var runCode:String
    public var runAddress:String
    public var runZone:String
    public var runBags:Int?
    public var runStage:String
    public var runNeeds:String
    public var runNote:String
    public var runEta:String
    public var odBase:Double?
    public var odPerBag:Double?
    public var holdCode:String
    public var holdReason:String
    public var holdEndUtc:Date?

    required public init(){}
}

public class DriverIncidentView : Codable
{
    public var incidentId:Int
    public var code:String
    public var kind:String
    public var kindDetail:String
    public var status:String
    public var loadCode:String
    public var truckCode:String
    public var locationText:String
    public var driverPref:String
    public var truckRecovery:String
    public var loadRecovery:String
    public var transloadTruckCode:String
    public var holdCode:String
    public var openedUtc:Date
    public var resolvedUtc: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 DriverPayLineView : Codable
{
    public var code:String
    public var module:String
    public var sourceLabel:String
    public var destinationLabel:String
    public var qtyText:String
    public var pay:Double?
    public var payPlanLabel:String
    public var status:String
    public var closedUtc:Date?
    public var openedUtc:Date
    public var ticketCode:String

    required public init(){}
}

Swift DriverIncidentOpenRequest 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/worker/dispatch/incident HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Kind: String,
	KindDetail: String,
	Note: String,
	DriverPref: String,
	LocationText: String,
	Lat: 0,
	Lng: 0,
	PhotoCount: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ContactId: 0,
	Name: String,
	Phone: String,
	PayPlanName: String,
	PayPlanBasis: String,
	PayPlanRate: 0,
	Truck: 
	{
		Code: String,
		Stage: String,
		StageSinceUtc: 0001-01-01,
		LoadsToday: 0,
		NetToday: 0,
		EstLoad: 0,
		Slot: String,
		SiteName: String,
		SupplierName: String,
		NextSiteName: String,
		Facility: String,
		FacilityShort: String,
		Unit: String,
		QueuePosition: 0,
		HoldCode: String,
		HoldReason: String,
		HoldEndUtc: 0001-01-01,
		OpenLoadId: 0,
		OpenLoadCode: String,
		OpenLoadPhotos: 0,
		Stamps: 
		[
			{
				Stage: String,
				AtUtc: 0001-01-01,
				Note: String
			}
		]
	},
	Rig: 
	{
		Code: String,
		Name: String,
		RigType: String,
		IsFree: False,
		HoldCode: String,
		HoldReason: String,
		HoldEndUtc: 0001-01-01
	},
	Jobs: 
	[
		{
			Kind: String,
			Code: String,
			Cargo: String,
			Customer: String,
			CustomerPhone: String,
			HoldContact: String,
			HoldPhone: String,
			FromLoc: String,
			ToLoc: String,
			Miles: 0,
			WindowText: String,
			Stage: String,
			Rate: 0,
			RequiredRig: String,
			EtaText: String,
			OfferExpiresUtc: 0001-01-01,
			RequestId: 0,
			LoadId: 0,
			LoadCode: String,
			LoadPay: 0,
			Photos: 0,
			Stamps: 
			[
				{
					Stage: String,
					AtUtc: 0001-01-01,
					Note: String
				}
			]
		}
	],
	Od: 
	{
		Code: String,
		Name: String,
		Zone: String,
		Status: String,
		Tier: String,
		Capabilities: String,
		PingCode: String,
		PingAddress: String,
		PingZone: String,
		PingBags: 0,
		PingNeeds: String,
		PingNote: String,
		PingExpiresUtc: 0001-01-01,
		RunCode: String,
		RunAddress: String,
		RunZone: String,
		RunBags: 0,
		RunStage: String,
		RunNeeds: String,
		RunNote: String,
		RunEta: String,
		OdBase: 0,
		OdPerBag: 0,
		HoldCode: String,
		HoldReason: String,
		HoldEndUtc: 0001-01-01
	},
	Incidents: 
	[
		{
			IncidentId: 0,
			Code: String,
			Kind: String,
			KindDetail: String,
			Status: String,
			LoadCode: String,
			TruckCode: String,
			LocationText: String,
			DriverPref: String,
			TruckRecovery: String,
			LoadRecovery: String,
			TransloadTruckCode: String,
			HoldCode: String,
			OpenedUtc: 0001-01-01,
			ResolvedUtc: 0001-01-01,
			Messages: 
			[
				{
					MessageId: 0,
					Who: String,
					Role: String,
					Msg: String,
					AtUtc: 0001-01-01
				}
			]
		}
	],
	Pay: 
	[
		{
			Code: String,
			Module: String,
			SourceLabel: String,
			DestinationLabel: String,
			QtyText: String,
			Pay: 0,
			PayPlanLabel: String,
			Status: String,
			ClosedUtc: 0001-01-01,
			OpenedUtc: 0001-01-01,
			TicketCode: String
		}
	],
	ServerUtc: 0001-01-01,
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}