| GET,OPTIONS | /v1/dispatch/loads |
|---|
"use strict";
export class DispatchLoadStageView {
/** @param {{Stage?:string,AtUtc?:string,Note?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Stage;
/** @type {string} */
AtUtc;
/** @type {string} */
Note;
}
export class DispatchLoadView {
/** @param {{LoadId?:number,Code?:string,Module?:string,TruckLabel?:string,DriverLabel?:string,CarrierLabel?:string,SourceLabel?:string,DestinationLabel?:string,Qty?:number,Unit?:string,QtyText?:string,TicketCode?:string,RateApplied?:number,RateBasis?:string,Revenue?:number,PayPlanLabel?:string,Pay?:number,Status?:string,OpenedUtc?:string,ClosedUtc?:string,Photos?:number,Stages?:DispatchLoadStageView[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
LoadId;
/** @type {string} */
Code;
/** @type {string} */
Module;
/** @type {string} */
TruckLabel;
/** @type {string} */
DriverLabel;
/** @type {string} */
CarrierLabel;
/** @type {string} */
SourceLabel;
/** @type {string} */
DestinationLabel;
/** @type {?number} */
Qty;
/** @type {string} */
Unit;
/** @type {string} */
QtyText;
/** @type {string} */
TicketCode;
/** @type {?number} */
RateApplied;
/** @type {string} */
RateBasis;
/** @type {?number} */
Revenue;
/** @type {string} */
PayPlanLabel;
/** @type {?number} */
Pay;
/** @type {string} */
Status;
/** @type {string} */
OpenedUtc;
/** @type {?string} */
ClosedUtc;
/** @type {number} */
Photos;
/** @type {DispatchLoadStageView[]} */
Stages = [];
}
export class DispatchLoadsResponse {
/** @param {{Loads?:DispatchLoadView[],Hours?:number,Total?:number,InFlight?:number,Priced?:number,Revenue?:number,Paid?:number,Pay?:number,PendingLoads?:number,Offset?:number,PageSize?:number,ModuleCounts?:{ [index:string]: number; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DispatchLoadView[]} */
Loads = [];
/** @type {number} */
Hours;
/** @type {number} */
Total;
/** @type {number} */
InFlight;
/** @type {number} */
Priced;
/** @type {?number} */
Revenue;
/** @type {number} */
Paid;
/** @type {?number} */
Pay;
/** @type {number} */
PendingLoads;
/** @type {number} */
Offset;
/** @type {number} */
PageSize;
/** @type {{ [index:string]: number; }} */
ModuleCounts = {};
/** @type {ResponseStatus} */
ResponseStatus;
}
export class DispatchLoadsRequest {
/** @param {{Hours?:number,Module?:string,Search?:string,Status?:string,Pending?:boolean,Offset?:number,PageSize?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Hours;
/** @type {string} */
Module;
/** @type {string} */
Search;
/** @type {string} */
Status;
/** @type {boolean} */
Pending;
/** @type {number} */
Offset;
/** @type {number} */
PageSize;
}
JavaScript DispatchLoadsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/dispatch/loads HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Loads:
[
{
LoadId: 0,
Code: String,
Module: String,
TruckLabel: String,
DriverLabel: String,
CarrierLabel: String,
SourceLabel: String,
DestinationLabel: String,
Qty: 0,
Unit: String,
QtyText: String,
TicketCode: String,
RateApplied: 0,
RateBasis: String,
Revenue: 0,
PayPlanLabel: String,
Pay: 0,
Status: String,
OpenedUtc: 0001-01-01,
ClosedUtc: 0001-01-01,
Photos: 0,
Stages:
[
{
Stage: String,
AtUtc: 0001-01-01,
Note: String
}
]
}
],
Hours: 0,
Total: 0,
InFlight: 0,
Priced: 0,
Revenue: 0,
Paid: 0,
Pay: 0,
PendingLoads: 0,
Offset: 0,
PageSize: 0,
ModuleCounts:
{
String: 0
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}