Trendsic Platform Service

<back to all web services

CourierBookQuoteRequest

The following routes are available for this service:
POST,OPTIONS/v1/book/{Slug}/quote
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class CourierBookQuoteLine implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Kind=null,
        /** @var float */
        public float $Amount=0.0,
        /** @var float|null */
        public ?float $Qty=null,
        /** @var float|null */
        public ?float $Rate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Kind'])) $this->Kind = $o['Kind'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['Qty'])) $this->Qty = $o['Qty'];
        if (isset($o['Rate'])) $this->Rate = $o['Rate'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Kind)) $o['Kind'] = $this->Kind;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->Qty)) $o['Qty'] = $this->Qty;
        if (isset($this->Rate)) $o['Rate'] = $this->Rate;
        return empty($o) ? new class(){} : $o;
    }
}

class CourierBookQuoteResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Zone=null,
        /** @var float|null */
        public ?float $Miles=null,
        /** @var array<CourierBookQuoteLine>|null */
        public ?array $Lines=null,
        /** @var float */
        public float $Total=0.0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Zone'])) $this->Zone = $o['Zone'];
        if (isset($o['Miles'])) $this->Miles = $o['Miles'];
        if (isset($o['Lines'])) $this->Lines = JsonConverters::fromArray('CourierBookQuoteLine', $o['Lines']);
        if (isset($o['Total'])) $this->Total = $o['Total'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Zone)) $o['Zone'] = $this->Zone;
        if (isset($this->Miles)) $o['Miles'] = $this->Miles;
        if (isset($this->Lines)) $o['Lines'] = JsonConverters::toArray('CourierBookQuoteLine', $this->Lines);
        if (isset($this->Total)) $o['Total'] = $this->Total;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class CourierBookQuoteRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Slug=null,
        /** @var string|null */
        public ?string $Profile=null,
        /** @var string|null */
        public ?string $Level=null,
        /** @var int */
        public int $Units=0,
        /** @var string|null */
        public ?string $Zip=null,
        /** @var float|null */
        public ?float $Lat=null,
        /** @var float|null */
        public ?float $Lng=null,
        /** @var float|null */
        public ?float $DropLat=null,
        /** @var float|null */
        public ?float $DropLng=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Slug'])) $this->Slug = $o['Slug'];
        if (isset($o['Profile'])) $this->Profile = $o['Profile'];
        if (isset($o['Level'])) $this->Level = $o['Level'];
        if (isset($o['Units'])) $this->Units = $o['Units'];
        if (isset($o['Zip'])) $this->Zip = $o['Zip'];
        if (isset($o['Lat'])) $this->Lat = $o['Lat'];
        if (isset($o['Lng'])) $this->Lng = $o['Lng'];
        if (isset($o['DropLat'])) $this->DropLat = $o['DropLat'];
        if (isset($o['DropLng'])) $this->DropLng = $o['DropLng'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Slug)) $o['Slug'] = $this->Slug;
        if (isset($this->Profile)) $o['Profile'] = $this->Profile;
        if (isset($this->Level)) $o['Level'] = $this->Level;
        if (isset($this->Units)) $o['Units'] = $this->Units;
        if (isset($this->Zip)) $o['Zip'] = $this->Zip;
        if (isset($this->Lat)) $o['Lat'] = $this->Lat;
        if (isset($this->Lng)) $o['Lng'] = $this->Lng;
        if (isset($this->DropLat)) $o['DropLat'] = $this->DropLat;
        if (isset($this->DropLng)) $o['DropLng'] = $this->DropLng;
        return empty($o) ? new class(){} : $o;
    }
}

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