Trendsic Platform Service

<back to all web services

DispatchLoadsRequest

Requires Authentication
The following routes are available for this service:
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,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DispatchLoadView[]} */
    Loads = [];
    /** @type {number} */
    Hours;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchLoadsRequest {
    /** @param {{Hours?:number,Module?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Hours;
    /** @type {string} */
    Module;
}

JavaScript DispatchLoadsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","ClosedUtc":"0001-01-01T00:00:00.0000000","Photos":0,"Stages":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]}],"Hours":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}