Trendsic Platform Service

<back to all web services

CourierBookQuoteRequest

The following routes are available for this service:
POST,OPTIONS/v1/book/{Slug}/quote
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierBookQuoteLine:
    kind: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    qty: Optional[Decimal] = None
    rate: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierBookQuoteResponse:
    zone: Optional[str] = None
    miles: Optional[Decimal] = None
    lines: List[CourierBookQuoteLine] = field(default_factory=list)
    total: Decimal = decimal.Decimal(0)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierBookQuoteRequest:
    slug: Optional[str] = None
    profile: Optional[str] = None
    level: Optional[str] = None
    units: int = 0
    zip: Optional[str] = None
    lat: Optional[Decimal] = None
    lng: Optional[Decimal] = None
    drop_lat: Optional[Decimal] = None
    drop_lng: Optional[Decimal] = None

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