Trendsic Platform Service

<back to all web services

CourierBookQuoteRequest

The following routes are available for this service:
POST,OPTIONS/v1/book/{Slug}/quote
"use strict";
export class CourierBookQuoteLine {
    /** @param {{Kind?:string,Amount?:number,Qty?:number,Rate?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {number} */
    Amount;
    /** @type {?number} */
    Qty;
    /** @type {?number} */
    Rate;
}
export class CourierBookQuoteResponse {
    /** @param {{Zone?:string,Miles?:number,Lines?:CourierBookQuoteLine[],Total?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Zone;
    /** @type {?number} */
    Miles;
    /** @type {CourierBookQuoteLine[]} */
    Lines = [];
    /** @type {number} */
    Total;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CourierBookQuoteRequest {
    /** @param {{Slug?:string,Profile?:string,Level?:string,Units?:number,Zip?:string,Lat?:number,Lng?:number,DropLat?:number,DropLng?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Slug;
    /** @type {string} */
    Profile;
    /** @type {string} */
    Level;
    /** @type {number} */
    Units;
    /** @type {string} */
    Zip;
    /** @type {?number} */
    Lat;
    /** @type {?number} */
    Lng;
    /** @type {?number} */
    DropLat;
    /** @type {?number} */
    DropLng;
}

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

POST /v1/book/{Slug}/quote HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierBookQuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DropLat>0</DropLat>
  <DropLng>0</DropLng>
  <Lat>0</Lat>
  <Level>String</Level>
  <Lng>0</Lng>
  <Profile>String</Profile>
  <Slug>String</Slug>
  <Units>0</Units>
  <Zip>String</Zip>
</CourierBookQuoteRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierBookQuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Lines>
    <CourierBookQuoteLine>
      <Amount>0</Amount>
      <Kind>String</Kind>
      <Qty>0</Qty>
      <Rate>0</Rate>
    </CourierBookQuoteLine>
  </Lines>
  <Miles>0</Miles>
  <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>
  <Total>0</Total>
  <Zone>String</Zone>
</CourierBookQuoteResponse>