Trendsic Platform Service

<back to all web services

DispatchLoadsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/loads

export class DispatchLoadStageView
{
    public Stage: string;
    public AtUtc: string;
    public Note: string;

    public constructor(init?: Partial<DispatchLoadStageView>) { (Object as any).assign(this, init); }
}

export class DispatchLoadView
{
    public LoadId: number;
    public Code: string;
    public Module: string;
    public TruckLabel: string;
    public DriverLabel: string;
    public CarrierLabel: string;
    public SourceLabel: string;
    public DestinationLabel: string;
    public Qty?: number;
    public Unit: string;
    public QtyText: string;
    public TicketCode: string;
    public RateApplied?: number;
    public RateBasis: string;
    public Revenue?: number;
    public PayPlanLabel: string;
    public Pay?: number;
    public Status: string;
    public OpenedUtc: string;
    public ClosedUtc?: string;
    public Photos: number;
    public Stages: DispatchLoadStageView[] = [];

    public constructor(init?: Partial<DispatchLoadView>) { (Object as any).assign(this, init); }
}

export class DispatchLoadsResponse
{
    public Loads: DispatchLoadView[] = [];
    public Hours: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchLoadsResponse>) { (Object as any).assign(this, init); }
}

export class DispatchLoadsRequest
{
    public Hours: number;
    public Module: string;

    public constructor(init?: Partial<DispatchLoadsRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchLoadsRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}