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
"use strict";
export class CourierPayLineView {
    /** @param {{DispatchLoadID?:number,Kind?:string,Label?:string,Qty?:number,Rate?:number,Amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DispatchLoadID;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Label;
    /** @type {?number} */
    Qty;
    /** @type {?number} */
    Rate;
    /** @type {number} */
    Amount;
}
export class CourierDriverPayRow {
    /** @param {{DispatchLoadID?:number,Code?:string,Kind?:string,OrderCode?:string,RunCode?:string,QtyText?:string,SourceLabel?:string,DestinationLabel?:string,Status?:string,Pay?:number,OpenedUtc?:string,ClosedUtc?:string,Lines?:CourierPayLineView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DispatchLoadID;
    /** @type {string} */
    Code;
    /** @type {string} */
    Kind;
    /** @type {string} */
    OrderCode;
    /** @type {string} */
    RunCode;
    /** @type {string} */
    QtyText;
    /** @type {string} */
    SourceLabel;
    /** @type {string} */
    DestinationLabel;
    /** @type {string} */
    Status;
    /** @type {?number} */
    Pay;
    /** @type {?string} */
    OpenedUtc;
    /** @type {?string} */
    ClosedUtc;
    /** @type {CourierPayLineView[]} */
    Lines = [];
}
export class CourierDriverPayResponse {
    /** @param {{Rows?:CourierDriverPayRow[],Total?:number,Available?:boolean,ServerUtc?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CourierDriverPayRow[]} */
    Rows = [];
    /** @type {number} */
    Total;
    /** @type {boolean} */
    Available;
    /** @type {string} */
    ServerUtc;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CourierDriverPayRequest {
    constructor(init) { Object.assign(this, init) }
}

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