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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchLoadsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Hours>0</Hours>
  <Loads>
    <DispatchLoadView>
      <CarrierLabel>String</CarrierLabel>
      <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
      <Code>String</Code>
      <DestinationLabel>String</DestinationLabel>
      <DriverLabel>String</DriverLabel>
      <LoadId>0</LoadId>
      <Module>String</Module>
      <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
      <Pay>0</Pay>
      <PayPlanLabel>String</PayPlanLabel>
      <Photos>0</Photos>
      <Qty>0</Qty>
      <QtyText>String</QtyText>
      <RateApplied>0</RateApplied>
      <RateBasis>String</RateBasis>
      <Revenue>0</Revenue>
      <SourceLabel>String</SourceLabel>
      <Stages>
        <DispatchLoadStageView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Note>String</Note>
          <Stage>String</Stage>
        </DispatchLoadStageView>
      </Stages>
      <Status>String</Status>
      <TicketCode>String</TicketCode>
      <TruckLabel>String</TruckLabel>
      <Unit>String</Unit>
    </DispatchLoadView>
  </Loads>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DispatchLoadsResponse>