Trendsic Platform Service

CourierDriverLocationRequest

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

**CourierDriverLocationRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Lat	body	decimal	No
Lng	body	decimal	No

**CourierDriverResponse** Parameters:
Name	Parameter	Data Type	Required
Courier	form	CourierDriverView	No
Result	form	string	No
Detail	form	string	No
Message	form	string	No
ResponseStatus	form	ResponseStatus	No

**CourierDriverView** Parameters:
Name	Parameter	Data Type	Required
DriverCode	form	string	No
Name	form	string	No
Online	form	bool	No
OnRoster	form	bool	No
Van	form	CourierVanView	No
Current	form	CourierDriverOrder	No
Queue	form	List<CourierDriverOrder>	No
Aboard	form	List<CourierDriverOrder>	No
Runs	form	List<CourierRunView>	No
UpNext	form	CourierDriverOrder	No

**CourierVanView** Parameters:
Name	Parameter	Data Type	Required
State	form	string	No
LeaveByUtc	form	DateTime?	No
LeaveByText	form	string	No
SlackMin	form	int?	No
InVan	form	int	No
Committed	form	int	No
Cap	form	decimal?	No
CapUnit	form	string	No
VehicleUnit	form	string	No
CriticalCode	form	string	No
DriveMin	form	int	No
FacilityName	form	string	No
SendNote	form	string	No

**CourierDriverOrder** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
CourierStep	form	string	No
RouteShape	form	string	No
ProfileName	form	string	No
UnitOne	form	string	No
UnitMany	form	string	No
FacilityNoun	form	string	No
FacilityName	form	string	No
LevelName	form	string	No
DueUtc	form	DateTime?	No
DueText	form	string	No
Units	form	int	No
UnitsFound	form	int?	No
Area	form	string	No
Minutes	form	int?	No
Address	form	string	No
Unit	form	string	No
City	form	string	No
Lat	form	decimal?	No
Lng	form	decimal?	No
CustomerName	form	string	No
CustomerPhone	form	string	No
Handoff	form	string	No
GateCode	form	string	No
Instructions	form	string	No
DropoffAddress	form	string	No
DropoffContactName	form	string	No
DropLat	form	decimal?	No
DropLng	form	decimal?	No
ArrivedUtc	form	DateTime?	No
Tags	form	List<CourierItemView>	No
Proof	form	Dictionary<string, string>	No
Photos	form	Dictionary<string, int>	No
Needs	form	List<string>	No
MissedWaitMin	form	int	No
MissedRequireContact	form	bool	No
MissedRequirePhoto	form	bool	No
MissedFee	form	decimal	No

**CourierItemView** Parameters:
Name	Parameter	Data Type	Required
CourierItemID	form	int	No
DispatchOdRequestID	form	int	No
Seq	form	int	No
TagCode	form	string	No
Custody	form	string	No
IsOpen	form	bool	No
IsMissing	form	bool	No
MissingReason	form	string	No
IsManual	form	bool	No
ReTagFlag	form	bool	No
Scanned	form	bool	No

**CourierRunView** Parameters:
Name	Parameter	Data Type	Required
CourierRunID	form	int	No
Code	form	string	No
Status	form	string	No
CourierProfileId	form	int	No
ProfileName	form	string	No
CourierFacilityId	form	int	No
FacilityName	form	string	No
FacilityAddress	form	string	No
DriverContactId	form	int?	No
DriverName	form	string	No
EquipmentID	form	int?	No
VehicleUnit	form	string	No
UnitOne	form	string	No
UnitMany	form	string	No
Units	form	int	No
StopCount	form	int	No
StopsDone	form	int	No
Pay	form	decimal?	No
BuiltUtc	form	DateTime?	No
StartedUtc	form	DateTime?	No
CompletedUtc	form	DateTime?	No
ToLoad	form	int	No
ToReturn	form	int	No
Stops	form	List<CourierStopView>	No

**CourierStopView** Parameters:
Name	Parameter	Data Type	Required
Sequence	form	int	No
Status	form	string	No
DispatchOdRequestID	form	int	No
Code	form	string	No
CourierStep	form	string	No
Address	form	string	No
Unit	form	string	No
City	form	string	No
Zip	form	string	No
Lat	form	decimal?	No
Lng	form	decimal?	No
CustomerName	form	string	No
CustomerPhone	form	string	No
Handoff	form	string	No
GateCode	form	string	No
Instructions	form	string	No
Units	form	int	No
DueText	form	string	No
Note	form	string	No
Needs	form	List<string>	No
Items	form	List<CourierItemView>	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/od/location HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Lat: 0,
	Lng: 0
}

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

{
	Courier: 
	{
		DriverCode: String,
		Name: String,
		Online: False,
		OnRoster: False,
		Van: 
		{
			State: String,
			LeaveByUtc: 0001-01-01,
			LeaveByText: String,
			SlackMin: 0,
			InVan: 0,
			Committed: 0,
			Cap: 0,
			CapUnit: String,
			VehicleUnit: String,
			CriticalCode: String,
			DriveMin: 0,
			FacilityName: String,
			SendNote: String
		},
		Current: 
		{
			Code: String,
			CourierStep: String,
			RouteShape: String,
			ProfileName: String,
			UnitOne: String,
			UnitMany: String,
			FacilityNoun: String,
			FacilityName: String,
			LevelName: String,
			DueUtc: 0001-01-01,
			DueText: String,
			Units: 0,
			UnitsFound: 0,
			Area: String,
			Minutes: 0,
			Address: String,
			Unit: String,
			City: String,
			Lat: 0,
			Lng: 0,
			CustomerName: String,
			CustomerPhone: String,
			Handoff: String,
			GateCode: String,
			Instructions: String,
			DropoffAddress: String,
			DropoffContactName: String,
			DropLat: 0,
			DropLng: 0,
			ArrivedUtc: 0001-01-01,
			Tags: 
			[
				{
					CourierItemID: 0,
					DispatchOdRequestID: 0,
					Seq: 0,
					TagCode: String,
					Custody: String,
					IsOpen: False,
					IsMissing: False,
					MissingReason: String,
					IsManual: False,
					ReTagFlag: False,
					Scanned: False
				}
			],
			Proof: 
			{
				String: String
			},
			Photos: 
			{
				String: 0
			},
			Needs: 
			[
				String
			],
			MissedWaitMin: 0,
			MissedRequireContact: False,
			MissedRequirePhoto: False,
			MissedFee: 0
		},
		Queue: 
		[
			{
				Code: String,
				CourierStep: String,
				RouteShape: String,
				ProfileName: String,
				UnitOne: String,
				UnitMany: String,
				FacilityNoun: String,
				FacilityName: String,
				LevelName: String,
				DueUtc: 0001-01-01,
				DueText: String,
				Units: 0,
				UnitsFound: 0,
				Area: String,
				Minutes: 0,
				Address: String,
				Unit: String,
				City: String,
				Lat: 0,
				Lng: 0,
				CustomerName: String,
				CustomerPhone: String,
				Handoff: String,
				GateCode: String,
				Instructions: String,
				DropoffAddress: String,
				DropoffContactName: String,
				DropLat: 0,
				DropLng: 0,
				ArrivedUtc: 0001-01-01,
				Tags: 
				[
					{
						CourierItemID: 0,
						DispatchOdRequestID: 0,
						Seq: 0,
						TagCode: String,
						Custody: String,
						IsOpen: False,
						IsMissing: False,
						MissingReason: String,
						IsManual: False,
						ReTagFlag: False,
						Scanned: False
					}
				],
				Proof: 
				{
					String: String
				},
				Photos: 
				{
					String: 0
				},
				Needs: 
				[
					String
				],
				MissedWaitMin: 0,
				MissedRequireContact: False,
				MissedRequirePhoto: False,
				MissedFee: 0
			}
		],
		Aboard: 
		[
			{
				Code: String,
				CourierStep: String,
				RouteShape: String,
				ProfileName: String,
				UnitOne: String,
				UnitMany: String,
				FacilityNoun: String,
				FacilityName: String,
				LevelName: String,
				DueUtc: 0001-01-01,
				DueText: String,
				Units: 0,
				UnitsFound: 0,
				Area: String,
				Minutes: 0,
				Address: String,
				Unit: String,
				City: String,
				Lat: 0,
				Lng: 0,
				CustomerName: String,
				CustomerPhone: String,
				Handoff: String,
				GateCode: String,
				Instructions: String,
				DropoffAddress: String,
				DropoffContactName: String,
				DropLat: 0,
				DropLng: 0,
				ArrivedUtc: 0001-01-01,
				Tags: 
				[
					{
						CourierItemID: 0,
						DispatchOdRequestID: 0,
						Seq: 0,
						TagCode: String,
						Custody: String,
						IsOpen: False,
						IsMissing: False,
						MissingReason: String,
						IsManual: False,
						ReTagFlag: False,
						Scanned: False
					}
				],
				Proof: 
				{
					String: String
				},
				Photos: 
				{
					String: 0
				},
				Needs: 
				[
					String
				],
				MissedWaitMin: 0,
				MissedRequireContact: False,
				MissedRequirePhoto: False,
				MissedFee: 0
			}
		],
		Runs: 
		[
			{
				CourierRunID: 0,
				Code: String,
				Status: String,
				CourierProfileId: 0,
				ProfileName: String,
				CourierFacilityId: 0,
				FacilityName: String,
				FacilityAddress: String,
				DriverContactId: 0,
				DriverName: String,
				EquipmentID: 0,
				VehicleUnit: String,
				UnitOne: String,
				UnitMany: String,
				Units: 0,
				StopCount: 0,
				StopsDone: 0,
				Pay: 0,
				BuiltUtc: 0001-01-01,
				StartedUtc: 0001-01-01,
				CompletedUtc: 0001-01-01,
				ToLoad: 0,
				ToReturn: 0,
				Stops: 
				[
					{
						Sequence: 0,
						Status: String,
						DispatchOdRequestID: 0,
						Code: String,
						CourierStep: String,
						Address: String,
						Unit: String,
						City: String,
						Zip: String,
						Lat: 0,
						Lng: 0,
						CustomerName: String,
						CustomerPhone: String,
						Handoff: String,
						GateCode: String,
						Instructions: String,
						Units: 0,
						DueText: String,
						Note: String,
						Needs: 
						[
							String
						],
						Items: 
						[
							{
								CourierItemID: 0,
								DispatchOdRequestID: 0,
								Seq: 0,
								TagCode: String,
								Custody: String,
								IsOpen: False,
								IsMissing: False,
								MissingReason: String,
								IsManual: False,
								ReTagFlag: False,
								Scanned: False
							}
						]
					}
				]
			}
		],
		UpNext: 
		{
			Code: String,
			CourierStep: String,
			RouteShape: String,
			ProfileName: String,
			UnitOne: String,
			UnitMany: String,
			FacilityNoun: String,
			FacilityName: String,
			LevelName: String,
			DueUtc: 0001-01-01,
			DueText: String,
			Units: 0,
			UnitsFound: 0,
			Area: String,
			Minutes: 0,
			Address: String,
			Unit: String,
			City: String,
			Lat: 0,
			Lng: 0,
			CustomerName: String,
			CustomerPhone: String,
			Handoff: String,
			GateCode: String,
			Instructions: String,
			DropoffAddress: String,
			DropoffContactName: String,
			DropLat: 0,
			DropLng: 0,
			ArrivedUtc: 0001-01-01,
			Tags: 
			[
				{
					CourierItemID: 0,
					DispatchOdRequestID: 0,
					Seq: 0,
					TagCode: String,
					Custody: String,
					IsOpen: False,
					IsMissing: False,
					MissingReason: String,
					IsManual: False,
					ReTagFlag: False,
					Scanned: False
				}
			],
			Proof: 
			{
				String: String
			},
			Photos: 
			{
				String: 0
			},
			Needs: 
			[
				String
			],
			MissedWaitMin: 0,
			MissedRequireContact: False,
			MissedRequirePhoto: False,
			MissedFee: 0
		}
	},
	Result: String,
	Detail: String,
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}