Trendsic Platform Service

<back to all web services

DispatchLoadsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/loads
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class DispatchLoadsRequest
    {
        public Integer Hours = null;
        public String Module = null;
        
        public Integer getHours() { return Hours; }
        public DispatchLoadsRequest setHours(Integer value) { this.Hours = value; return this; }
        public String getModule() { return Module; }
        public DispatchLoadsRequest setModule(String value) { this.Module = value; return this; }
    }

    public static class DispatchLoadsResponse
    {
        public ArrayList<DispatchLoadView> Loads = new ArrayList<DispatchLoadView>();
        public Integer Hours = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<DispatchLoadView> getLoads() { return Loads; }
        public DispatchLoadsResponse setLoads(ArrayList<DispatchLoadView> value) { this.Loads = value; return this; }
        public Integer getHours() { return Hours; }
        public DispatchLoadsResponse setHours(Integer value) { this.Hours = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DispatchLoadsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class DispatchLoadView
    {
        public Integer LoadId = null;
        public String Code = null;
        public String Module = null;
        public String TruckLabel = null;
        public String DriverLabel = null;
        public String CarrierLabel = null;
        public String SourceLabel = null;
        public String DestinationLabel = null;
        public BigDecimal Qty = null;
        public String Unit = null;
        public String QtyText = null;
        public String TicketCode = null;
        public BigDecimal RateApplied = null;
        public String RateBasis = null;
        public BigDecimal Revenue = null;
        public String PayPlanLabel = null;
        public BigDecimal Pay = null;
        public String Status = null;
        public Date OpenedUtc = null;
        public Date ClosedUtc = null;
        public Integer Photos = null;
        public ArrayList<DispatchLoadStageView> Stages = new ArrayList<DispatchLoadStageView>();
        
        public Integer getLoadId() { return LoadId; }
        public DispatchLoadView setLoadId(Integer value) { this.LoadId = value; return this; }
        public String getCode() { return Code; }
        public DispatchLoadView setCode(String value) { this.Code = value; return this; }
        public String getModule() { return Module; }
        public DispatchLoadView setModule(String value) { this.Module = value; return this; }
        public String getTruckLabel() { return TruckLabel; }
        public DispatchLoadView setTruckLabel(String value) { this.TruckLabel = value; return this; }
        public String getDriverLabel() { return DriverLabel; }
        public DispatchLoadView setDriverLabel(String value) { this.DriverLabel = value; return this; }
        public String getCarrierLabel() { return CarrierLabel; }
        public DispatchLoadView setCarrierLabel(String value) { this.CarrierLabel = value; return this; }
        public String getSourceLabel() { return SourceLabel; }
        public DispatchLoadView setSourceLabel(String value) { this.SourceLabel = value; return this; }
        public String getDestinationLabel() { return DestinationLabel; }
        public DispatchLoadView setDestinationLabel(String value) { this.DestinationLabel = value; return this; }
        public BigDecimal getQty() { return Qty; }
        public DispatchLoadView setQty(BigDecimal value) { this.Qty = value; return this; }
        public String getUnit() { return Unit; }
        public DispatchLoadView setUnit(String value) { this.Unit = value; return this; }
        public String getQtyText() { return QtyText; }
        public DispatchLoadView setQtyText(String value) { this.QtyText = value; return this; }
        public String getTicketCode() { return TicketCode; }
        public DispatchLoadView setTicketCode(String value) { this.TicketCode = value; return this; }
        public BigDecimal getRateApplied() { return RateApplied; }
        public DispatchLoadView setRateApplied(BigDecimal value) { this.RateApplied = value; return this; }
        public String getRateBasis() { return RateBasis; }
        public DispatchLoadView setRateBasis(String value) { this.RateBasis = value; return this; }
        public BigDecimal getRevenue() { return Revenue; }
        public DispatchLoadView setRevenue(BigDecimal value) { this.Revenue = value; return this; }
        public String getPayPlanLabel() { return PayPlanLabel; }
        public DispatchLoadView setPayPlanLabel(String value) { this.PayPlanLabel = value; return this; }
        public BigDecimal getPay() { return Pay; }
        public DispatchLoadView setPay(BigDecimal value) { this.Pay = value; return this; }
        public String getStatus() { return Status; }
        public DispatchLoadView setStatus(String value) { this.Status = value; return this; }
        public Date getOpenedUtc() { return OpenedUtc; }
        public DispatchLoadView setOpenedUtc(Date value) { this.OpenedUtc = value; return this; }
        public Date getClosedUtc() { return ClosedUtc; }
        public DispatchLoadView setClosedUtc(Date value) { this.ClosedUtc = value; return this; }
        public Integer getPhotos() { return Photos; }
        public DispatchLoadView setPhotos(Integer value) { this.Photos = value; return this; }
        public ArrayList<DispatchLoadStageView> getStages() { return Stages; }
        public DispatchLoadView setStages(ArrayList<DispatchLoadStageView> value) { this.Stages = value; return this; }
    }

    public static class DispatchLoadStageView
    {
        public String Stage = null;
        public Date AtUtc = null;
        public String Note = null;
        
        public String getStage() { return Stage; }
        public DispatchLoadStageView setStage(String value) { this.Stage = value; return this; }
        public Date getAtUtc() { return AtUtc; }
        public DispatchLoadStageView setAtUtc(Date value) { this.AtUtc = value; return this; }
        public String getNote() { return Note; }
        public DispatchLoadStageView setNote(String value) { this.Note = value; return this; }
    }

}

Java 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>