Trendsic Platform Service

CourierVansRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/courier/vans

**CourierOfficeResponse** Parameters:
Name	Parameter	Data Type	Required
Office	form	CourierOfficeView	No
Available	form	bool	No
ResponseStatus	form	ResponseStatus	No

**CourierOfficeView** Parameters:
Name	Parameter	Data Type	Required
ServerUtc	form	DateTime	No
Vans	form	List<CourierOfficeVan>	No
Held	form	List<CourierHeldView>	No
Vehicles	form	List<CourierVehicleOption>	No
Profiles	form	List<CourierProfileOption>	No
Drivers	form	List<CourierDriverOption>	No
Desk	form	List<CourierDeskRow>	No
GoCount	form	int	No
HeldCount	form	int	No
ReadyToOffer	form	int	No
IntakeMin	form	int?	No
FacilityNoun	form	string	No

**CourierOfficeVan** Parameters:
Name	Parameter	Data Type	Required
DriverContactId	form	int	No
DriverCode	form	string	No
Name	form	string	No
Online	form	bool	No
Zone	form	string	No
VehicleUnit	form	string	No
FacilityName	form	string	No
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
UnitMany	form	string	No
CriticalCode	form	string	No
DriveMin	form	int	No
SendNote	form	string	No
Aboard	form	List<CourierVanChip>	No
Queued	form	List<CourierVanChip>	No

**CourierVanChip** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
CourierStep	form	string	No
LevelCode	form	string	No
LevelName	form	string	No
Units	form	int	No
Area	form	string	No
DueUtc	form	DateTime?	No
DueText	form	string	No
Movable	form	bool	No
NoMoveWhy	form	string	No
Targets	form	List<CourierMoveTarget>	No

**CourierMoveTarget** Parameters:
Name	Parameter	Data Type	Required
DriverContactId	form	int	No
Name	form	string	No
Ok	form	bool	No
Why	form	string	No
LeaveByText	form	string	No

**CourierHeldView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Area	form	string	No
Units	form	int	No
UnitMany	form	string	No
Miles	form	decimal?	No
LevelCode	form	string	No
LevelName	form	string	No
DueText	form	string	No
HeldReason	form	string	No
HeldMin	form	int?	No
Why	form	List<string>	No
BestDriverContactId	form	int?	No
BestName	form	string	No
BestLeaveByText	form	string	No

**CourierVehicleOption** Parameters:
Name	Parameter	Data Type	Required
CourierProfileId	form	int	No
EquipmentID	form	int	No
UnitNumber	form	string	No
VehicleType	form	string	No
CapacityUnit	form	string	No
CapacityLimit	form	decimal?	No
IsRefrigerated	form	bool	No
Status	form	string	No

**CourierProfileOption** Parameters:
Name	Parameter	Data Type	Required
CourierProfileID	form	int	No
Name	form	string	No
RouteShape	form	string	No
Enabled	form	bool	No
UnitOne	form	string	No
UnitMany	form	string	No
FacilityNoun	form	string	No
Facilities	form	List<CourierFacilityOption>	No

**CourierFacilityOption** Parameters:
Name	Parameter	Data Type	Required
CourierFacilityID	form	int	No
Code	form	string	No
Name	form	string	No
Address	form	string	No
IntakeMin	form	int	No

**CourierDriverOption** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
Code	form	string	No
Name	form	string	No
Online	form	bool	No
Zone	form	string	No
VehicleUnit	form	string	No
EquipmentID	form	int?	No
SentToFacility	form	bool	No

**CourierDeskRow** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
CourierProfileId	form	int	No
FacilityName	form	string	No
LevelCode	form	string	No
LevelName	form	string	No
DueUtc	form	DateTime?	No
DueText	form	string	No
Units	form	int	No
UnitsFound	form	int?	No
UnitMany	form	string	No
Fare	form	decimal?	No
FinalPrice	form	decimal?	No
TipAmount	form	decimal?	No
PayMode	form	string	No
CaptureMode	form	string	No
CustomerName	form	string	No
Area	form	string	No
IntakeUtc	form	DateTime?	No
IntakeMinAgo	form	int?	No
DamageNote	form	string	No
FinalPriceAfterCount	form	bool	No
NeedsPrice	form	bool	No
ItemCount	form	int	No
MissingCount	form	int	No
PhotoCount	form	int	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.

GET /v1/dispatch/courier/vans HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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

{
	Office: 
	{
		ServerUtc: 0001-01-01,
		Vans: 
		[
			{
				DriverContactId: 0,
				DriverCode: String,
				Name: String,
				Online: False,
				Zone: String,
				VehicleUnit: String,
				FacilityName: String,
				State: String,
				LeaveByUtc: 0001-01-01,
				LeaveByText: String,
				SlackMin: 0,
				InVan: 0,
				Committed: 0,
				Cap: 0,
				CapUnit: String,
				UnitMany: String,
				CriticalCode: String,
				DriveMin: 0,
				SendNote: String,
				Aboard: 
				[
					{
						Code: String,
						CourierStep: String,
						LevelCode: String,
						LevelName: String,
						Units: 0,
						Area: String,
						DueUtc: 0001-01-01,
						DueText: String,
						Movable: False,
						NoMoveWhy: String,
						Targets: 
						[
							{
								DriverContactId: 0,
								Name: String,
								Ok: False,
								Why: String,
								LeaveByText: String
							}
						]
					}
				],
				Queued: 
				[
					{
						Code: String,
						CourierStep: String,
						LevelCode: String,
						LevelName: String,
						Units: 0,
						Area: String,
						DueUtc: 0001-01-01,
						DueText: String,
						Movable: False,
						NoMoveWhy: String,
						Targets: 
						[
							{
								DriverContactId: 0,
								Name: String,
								Ok: False,
								Why: String,
								LeaveByText: String
							}
						]
					}
				]
			}
		],
		Held: 
		[
			{
				Code: String,
				Area: String,
				Units: 0,
				UnitMany: String,
				Miles: 0,
				LevelCode: String,
				LevelName: String,
				DueText: String,
				HeldReason: String,
				HeldMin: 0,
				Why: 
				[
					String
				],
				BestDriverContactId: 0,
				BestName: String,
				BestLeaveByText: String
			}
		],
		Vehicles: 
		[
			{
				CourierProfileId: 0,
				EquipmentID: 0,
				UnitNumber: String,
				VehicleType: String,
				CapacityUnit: String,
				CapacityLimit: 0,
				IsRefrigerated: False,
				Status: String
			}
		],
		Profiles: 
		[
			{
				CourierProfileID: 0,
				Name: String,
				RouteShape: String,
				Enabled: False,
				UnitOne: String,
				UnitMany: String,
				FacilityNoun: String,
				Facilities: 
				[
					{
						CourierFacilityID: 0,
						Code: String,
						Name: String,
						Address: String,
						IntakeMin: 0
					}
				]
			}
		],
		Drivers: 
		[
			{
				ContactId: 0,
				Code: String,
				Name: String,
				Online: False,
				Zone: String,
				VehicleUnit: String,
				EquipmentID: 0,
				SentToFacility: False
			}
		],
		Desk: 
		[
			{
				Code: String,
				CourierProfileId: 0,
				FacilityName: String,
				LevelCode: String,
				LevelName: String,
				DueUtc: 0001-01-01,
				DueText: String,
				Units: 0,
				UnitsFound: 0,
				UnitMany: String,
				Fare: 0,
				FinalPrice: 0,
				TipAmount: 0,
				PayMode: String,
				CaptureMode: String,
				CustomerName: String,
				Area: String,
				IntakeUtc: 0001-01-01,
				IntakeMinAgo: 0,
				DamageNote: String,
				FinalPriceAfterCount: False,
				NeedsPrice: False,
				ItemCount: 0,
				MissingCount: 0,
				PhotoCount: 0
			}
		],
		GoCount: 0,
		HeldCount: 0,
		ReadyToOffer: 0,
		IntakeMin: 0,
		FacilityNoun: String
	},
	Available: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}