Trendsic Platform Service

<back to all web services

CourierDriverPayRequest

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

public class dtos
{

    public static class CourierDriverPayRequest
    {
        
    }

    public static class CourierDriverPayResponse
    {
        public ArrayList<CourierDriverPayRow> Rows = new ArrayList<CourierDriverPayRow>();
        public BigDecimal Total = null;
        public Boolean Available = null;
        public Date ServerUtc = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<CourierDriverPayRow> getRows() { return Rows; }
        public CourierDriverPayResponse setRows(ArrayList<CourierDriverPayRow> value) { this.Rows = value; return this; }
        public BigDecimal getTotal() { return Total; }
        public CourierDriverPayResponse setTotal(BigDecimal value) { this.Total = value; return this; }
        public Boolean isAvailable() { return Available; }
        public CourierDriverPayResponse setAvailable(Boolean value) { this.Available = value; return this; }
        public Date getServerUtc() { return ServerUtc; }
        public CourierDriverPayResponse setServerUtc(Date value) { this.ServerUtc = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CourierDriverPayResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CourierDriverPayRow
    {
        public Integer DispatchLoadID = null;
        public String Code = null;
        public String Kind = null;
        public String OrderCode = null;
        public String RunCode = null;
        public String QtyText = null;
        public String SourceLabel = null;
        public String DestinationLabel = null;
        public String Status = null;
        public BigDecimal Pay = null;
        public Date OpenedUtc = null;
        public Date ClosedUtc = null;
        public ArrayList<CourierPayLineView> Lines = new ArrayList<CourierPayLineView>();
        
        public Integer getDispatchLoadID() { return DispatchLoadID; }
        public CourierDriverPayRow setDispatchLoadID(Integer value) { this.DispatchLoadID = value; return this; }
        public String getCode() { return Code; }
        public CourierDriverPayRow setCode(String value) { this.Code = value; return this; }
        public String getKind() { return Kind; }
        public CourierDriverPayRow setKind(String value) { this.Kind = value; return this; }
        public String getOrderCode() { return OrderCode; }
        public CourierDriverPayRow setOrderCode(String value) { this.OrderCode = value; return this; }
        public String getRunCode() { return RunCode; }
        public CourierDriverPayRow setRunCode(String value) { this.RunCode = value; return this; }
        public String getQtyText() { return QtyText; }
        public CourierDriverPayRow setQtyText(String value) { this.QtyText = value; return this; }
        public String getSourceLabel() { return SourceLabel; }
        public CourierDriverPayRow setSourceLabel(String value) { this.SourceLabel = value; return this; }
        public String getDestinationLabel() { return DestinationLabel; }
        public CourierDriverPayRow setDestinationLabel(String value) { this.DestinationLabel = value; return this; }
        public String getStatus() { return Status; }
        public CourierDriverPayRow setStatus(String value) { this.Status = value; return this; }
        public BigDecimal getPay() { return Pay; }
        public CourierDriverPayRow setPay(BigDecimal value) { this.Pay = value; return this; }
        public Date getOpenedUtc() { return OpenedUtc; }
        public CourierDriverPayRow setOpenedUtc(Date value) { this.OpenedUtc = value; return this; }
        public Date getClosedUtc() { return ClosedUtc; }
        public CourierDriverPayRow setClosedUtc(Date value) { this.ClosedUtc = value; return this; }
        public ArrayList<CourierPayLineView> getLines() { return Lines; }
        public CourierDriverPayRow setLines(ArrayList<CourierPayLineView> value) { this.Lines = value; return this; }
    }

    public static class CourierPayLineView
    {
        public Integer DispatchLoadID = null;
        public String Kind = null;
        public String Label = null;
        public BigDecimal Qty = null;
        public BigDecimal Rate = null;
        public BigDecimal Amount = null;
        
        public Integer getDispatchLoadID() { return DispatchLoadID; }
        public CourierPayLineView setDispatchLoadID(Integer value) { this.DispatchLoadID = value; return this; }
        public String getKind() { return Kind; }
        public CourierPayLineView setKind(String value) { this.Kind = value; return this; }
        public String getLabel() { return Label; }
        public CourierPayLineView setLabel(String value) { this.Label = value; return this; }
        public BigDecimal getQty() { return Qty; }
        public CourierPayLineView setQty(BigDecimal value) { this.Qty = value; return this; }
        public BigDecimal getRate() { return Rate; }
        public CourierPayLineView setRate(BigDecimal value) { this.Rate = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public CourierPayLineView setAmount(BigDecimal value) { this.Amount = value; return this; }
    }

}

Java CourierDriverPayRequest 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/worker/dispatch/od/pay HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierDriverPayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Available>false</Available>
  <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>
  <Rows>
    <CourierDriverPayRow>
      <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
      <Code>String</Code>
      <DestinationLabel>String</DestinationLabel>
      <DispatchLoadID>0</DispatchLoadID>
      <Kind>String</Kind>
      <Lines>
        <CourierPayLineView>
          <Amount>0</Amount>
          <DispatchLoadID>0</DispatchLoadID>
          <Kind>String</Kind>
          <Label>String</Label>
          <Qty>0</Qty>
          <Rate>0</Rate>
        </CourierPayLineView>
      </Lines>
      <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
      <OrderCode>String</OrderCode>
      <Pay>0</Pay>
      <QtyText>String</QtyText>
      <RunCode>String</RunCode>
      <SourceLabel>String</SourceLabel>
      <Status>String</Status>
    </CourierDriverPayRow>
  </Rows>
  <ServerUtc>0001-01-01T00:00:00</ServerUtc>
  <Total>0</Total>
</CourierDriverPayResponse>