Trendsic Platform Service

DispatchReportRequest

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

**DispatchReportRequest** Parameters:
Name	Parameter	Data Type	Required
FromDate	body	DateTime	No
ToDate	body	DateTime	No
LocationIds	body	List<Guid>	No

**DispatchReportResponse** Parameters:
Name	Parameter	Data Type	Required
Stats	form	List<DashboardStatTile>	No
Unit	form	string	No
Trend	form	List<DispatchReportDayRow>	No
ByModule	form	List<DispatchReportModuleRow>	No
ByLane	form	List<DispatchReportLaneRow>	No
ByTruck	form	List<DispatchReportTruckRow>	No
ByDriver	form	List<DispatchReportDriverRow>	No
Jobs	form	List<DispatchReportJobRow>	No
Incidents	form	List<DispatchReportIncidentRow>	No
Holds	form	List<DispatchReportHoldRow>	No
ResponseStatus	form	ResponseStatus	No

**DashboardStatTile** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
Value	form	double	No
PreviousValue	form	double?	No
Unit	form	string	No
DeltaPct	form	double?	No

**DispatchReportDayRow** Parameters:
Name	Parameter	Data Type	Required
Label	form	string	No
Loads	form	int	No
Revenue	form	double	No
Pay	form	double	No
Qty	form	double	No
AvgCycleMins	form	double?	No

**DispatchReportModuleRow** Parameters:
Name	Parameter	Data Type	Required
Module	form	string	No
Loads	form	int	No
Qty	form	double	No
Revenue	form	double	No
Pay	form	double	No

**DispatchReportLaneRow** Parameters:
Name	Parameter	Data Type	Required
SupplierName	form	string	No
SourceLabel	form	string	No
Loads	form	int	No
Qty	form	double	No
Revenue	form	double	No
AvgCycleMins	form	double?	No

**DispatchReportTruckRow** Parameters:
Name	Parameter	Data Type	Required
TruckLabel	form	string	No
DriverLabel	form	string	No
Loads	form	int	No
Qty	form	double	No
Revenue	form	double	No
Pay	form	double	No
AvgCycleMins	form	double?	No
DaysActive	form	int	No

**DispatchReportDriverRow** Parameters:
Name	Parameter	Data Type	Required
Driver	form	string	No
DriverContactId	form	int?	No
Loads	form	int	No
Qty	form	double	No
Pay	form	double	No
DaysActive	form	int	No
Unpriced	form	int	No

**DispatchReportJobRow** Parameters:
Name	Parameter	Data Type	Required
JobCode	form	string	No
Customer	form	string	No
Cargo	form	string	No
Route	form	string	No
Miles	form	int	No
Revenue	form	double?	No
Pay	form	double?	No
MarginPct	form	double?	No
ClosedUtc	form	DateTime?	No

**DispatchReportIncidentRow** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
Opened	form	int	No
Resolved	form	int	No
AvgResolveMins	form	double?	No

**DispatchReportHoldRow** Parameters:
Name	Parameter	Data Type	Required
ScopeKind	form	string	No
Holds	form	int	No
PausedMins	form	int	No
Weather	form	int	No
FromIncidents	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.

POST /v1/dashboard/dispatch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromDate: 0001-01-01,
	ToDate: 0001-01-01,
	LocationIds: 
	[
		00000000000000000000000000000000
	]
}

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

{
	Stats: 
	[
		{
			Key: String,
			Label: String,
			Value: 0,
			PreviousValue: 0,
			Unit: String
		}
	],
	Unit: String,
	Trend: 
	[
		{
			Label: String,
			Loads: 0,
			Revenue: 0,
			Pay: 0,
			Qty: 0,
			AvgCycleMins: 0
		}
	],
	ByModule: 
	[
		{
			Module: String,
			Loads: 0,
			Qty: 0,
			Revenue: 0,
			Pay: 0
		}
	],
	ByLane: 
	[
		{
			SupplierName: String,
			SourceLabel: String,
			Loads: 0,
			Qty: 0,
			Revenue: 0,
			AvgCycleMins: 0
		}
	],
	ByTruck: 
	[
		{
			TruckLabel: String,
			DriverLabel: String,
			Loads: 0,
			Qty: 0,
			Revenue: 0,
			Pay: 0,
			AvgCycleMins: 0,
			DaysActive: 0
		}
	],
	ByDriver: 
	[
		{
			Driver: String,
			DriverContactId: 0,
			Loads: 0,
			Qty: 0,
			Pay: 0,
			DaysActive: 0,
			Unpriced: 0
		}
	],
	Jobs: 
	[
		{
			JobCode: String,
			Customer: String,
			Cargo: String,
			Route: String,
			Miles: 0,
			Revenue: 0,
			Pay: 0,
			MarginPct: 0,
			ClosedUtc: 0001-01-01
		}
	],
	Incidents: 
	[
		{
			Kind: String,
			Opened: 0,
			Resolved: 0,
			AvgResolveMins: 0
		}
	],
	Holds: 
	[
		{
			ScopeKind: String,
			Holds: 0,
			PausedMins: 0,
			Weather: 0,
			FromIncidents: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}