Trendsic Platform Service

DriverPingAdvanceRequest

The following routes are available for this service:
POST,OPTIONS	/v1/worker/dispatch/ping/{Code}/advance

**DriverPingAdvanceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Code	path	string	No

**DriverMeResponse** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
Name	form	string	No
Phone	form	string	No
PayPlanName	form	string	No
PayPlanBasis	form	string	No
PayPlanRate	form	decimal?	No
Truck	form	DriverTruckView	No
Rig	form	DriverRigView	No
Jobs	form	List<DriverJobView>	No
Od	form	DriverOdView	No
Incidents	form	List<DriverIncidentView>	No
Pay	form	List<DriverPayLineView>	No
ServerUtc	form	DateTime	No
Message	form	string	No
ResponseStatus	form	ResponseStatus	No

**DriverTruckView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Stage	form	string	No
StageSinceUtc	form	DateTime?	No
LoadsToday	form	int	No
NetToday	form	decimal	No
EstLoad	form	decimal?	No
Slot	form	string	No
SiteName	form	string	No
SupplierName	form	string	No
NextSiteName	form	string	No
Facility	form	string	No
FacilityShort	form	string	No
Unit	form	string	No
QueuePosition	form	int?	No
HoldCode	form	string	No
HoldReason	form	string	No
HoldEndUtc	form	DateTime?	No
OpenLoadId	form	int?	No
OpenLoadCode	form	string	No
OpenLoadPhotos	form	int	No
Stamps	form	List<DriverStampView>	No

**DriverStampView** Parameters:
Name	Parameter	Data Type	Required
Stage	form	string	No
AtUtc	form	DateTime	No
Note	form	string	No

**DriverRigView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
RigType	form	string	No
IsFree	form	bool	No
HoldCode	form	string	No
HoldReason	form	string	No
HoldEndUtc	form	DateTime?	No

**DriverJobView** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
Code	form	string	No
Cargo	form	string	No
Customer	form	string	No
CustomerPhone	form	string	No
HoldContact	form	string	No
HoldPhone	form	string	No
FromLoc	form	string	No
ToLoc	form	string	No
Miles	form	int	No
WindowText	form	string	No
Stage	form	string	No
Rate	form	decimal?	No
RequiredRig	form	string	No
EtaText	form	string	No
OfferExpiresUtc	form	DateTime?	No
RequestId	form	int?	No
LoadId	form	int?	No
LoadCode	form	string	No
LoadPay	form	decimal?	No
Photos	form	int	No
Stamps	form	List<DriverStampView>	No

**DriverOdView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
Zone	form	string	No
Status	form	string	No
Tier	form	string	No
Capabilities	form	string	No
PingCode	form	string	No
PingAddress	form	string	No
PingZone	form	string	No
PingBags	form	int?	No
PingNeeds	form	string	No
PingNote	form	string	No
PingExpiresUtc	form	DateTime?	No
RunCode	form	string	No
RunAddress	form	string	No
RunZone	form	string	No
RunBags	form	int?	No
RunStage	form	string	No
RunNeeds	form	string	No
RunNote	form	string	No
RunEta	form	string	No
OdBase	form	decimal?	No
OdPerBag	form	decimal?	No
HoldCode	form	string	No
HoldReason	form	string	No
HoldEndUtc	form	DateTime?	No

**DriverIncidentView** Parameters:
Name	Parameter	Data Type	Required
IncidentId	form	int	No
Code	form	string	No
Kind	form	string	No
KindDetail	form	string	No
Status	form	string	No
LoadCode	form	string	No
TruckCode	form	string	No
LocationText	form	string	No
DriverPref	form	string	No
TruckRecovery	form	string	No
LoadRecovery	form	string	No
TransloadTruckCode	form	string	No
HoldCode	form	string	No
OpenedUtc	form	DateTime	No
ResolvedUtc	form	DateTime?	No
Messages	form	List<DispatchIncidentMessageView>	No

**DispatchIncidentMessageView** Parameters:
Name	Parameter	Data Type	Required
MessageId	form	int	No
Who	form	string	No
Role	form	string	No
Msg	form	string	No
AtUtc	form	DateTime	No

**DriverPayLineView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Module	form	string	No
SourceLabel	form	string	No
DestinationLabel	form	string	No
QtyText	form	string	No
Pay	form	decimal?	No
PayPlanLabel	form	string	No
Status	form	string	No
ClosedUtc	form	DateTime?	No
OpenedUtc	form	DateTime	No
TicketCode	form	string	No

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/ping/{Code}/advance HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Code: String
}

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