Trendsic Platform Service

<back to all web services

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
<?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 DispatchPickupBookResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=null,
        /** @var float */
        public float $Fare=0.0,
        /** @var string|null */
        public ?string $Zone=null,
        /** @var int */
        public int $Bags=0,
        /** @var string|null */
        public ?string $PayMode=null,
        /** @var string|null */
        public ?string $PayLine=null,
        /** @var string|null */
        public ?string $TrackUrl=null,
        /** @var string|null */
        public ?string $BookToken=null,
        /** @var string|null */
        public ?string $ClientSecret=null,
        /** @var string|null */
        public ?string $PublishableKey=null,
        /** @var string|null */
        public ?string $Delivery=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Fare'])) $this->Fare = $o['Fare'];
        if (isset($o['Zone'])) $this->Zone = $o['Zone'];
        if (isset($o['Bags'])) $this->Bags = $o['Bags'];
        if (isset($o['PayMode'])) $this->PayMode = $o['PayMode'];
        if (isset($o['PayLine'])) $this->PayLine = $o['PayLine'];
        if (isset($o['TrackUrl'])) $this->TrackUrl = $o['TrackUrl'];
        if (isset($o['BookToken'])) $this->BookToken = $o['BookToken'];
        if (isset($o['ClientSecret'])) $this->ClientSecret = $o['ClientSecret'];
        if (isset($o['PublishableKey'])) $this->PublishableKey = $o['PublishableKey'];
        if (isset($o['Delivery'])) $this->Delivery = $o['Delivery'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Fare)) $o['Fare'] = $this->Fare;
        if (isset($this->Zone)) $o['Zone'] = $this->Zone;
        if (isset($this->Bags)) $o['Bags'] = $this->Bags;
        if (isset($this->PayMode)) $o['PayMode'] = $this->PayMode;
        if (isset($this->PayLine)) $o['PayLine'] = $this->PayLine;
        if (isset($this->TrackUrl)) $o['TrackUrl'] = $this->TrackUrl;
        if (isset($this->BookToken)) $o['BookToken'] = $this->BookToken;
        if (isset($this->ClientSecret)) $o['ClientSecret'] = $this->ClientSecret;
        if (isset($this->PublishableKey)) $o['PublishableKey'] = $this->PublishableKey;
        if (isset($this->Delivery)) $o['Delivery'] = $this->Delivery;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class DispatchPickupBookRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $SchedulerUrl=null,
        /** @var string|null */
        public ?string $Address=null,
        /** @var string|null */
        public ?string $Unit=null,
        /** @var string|null */
        public ?string $City=null,
        /** @var string|null */
        public ?string $Zip=null,
        /** @var string|null */
        public ?string $Zone=null,
        /** @var int */
        public int $Bags=0,
        /** @var array<string>|null */
        public ?array $Needs=null,
        /** @var string|null */
        public ?string $Note=null,
        /** @var string|null */
        public ?string $CustomerName=null,
        /** @var string|null */
        public ?string $CustomerPhone=null,
        /** @var string|null */
        public ?string $PayMode=null,
        /** @var string|null */
        public ?string $AccountCode=null,
        /** @var string|null */
        public ?string $TurnstileToken=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SchedulerUrl'])) $this->SchedulerUrl = $o['SchedulerUrl'];
        if (isset($o['Address'])) $this->Address = $o['Address'];
        if (isset($o['Unit'])) $this->Unit = $o['Unit'];
        if (isset($o['City'])) $this->City = $o['City'];
        if (isset($o['Zip'])) $this->Zip = $o['Zip'];
        if (isset($o['Zone'])) $this->Zone = $o['Zone'];
        if (isset($o['Bags'])) $this->Bags = $o['Bags'];
        if (isset($o['Needs'])) $this->Needs = JsonConverters::fromArray('string', $o['Needs']);
        if (isset($o['Note'])) $this->Note = $o['Note'];
        if (isset($o['CustomerName'])) $this->CustomerName = $o['CustomerName'];
        if (isset($o['CustomerPhone'])) $this->CustomerPhone = $o['CustomerPhone'];
        if (isset($o['PayMode'])) $this->PayMode = $o['PayMode'];
        if (isset($o['AccountCode'])) $this->AccountCode = $o['AccountCode'];
        if (isset($o['TurnstileToken'])) $this->TurnstileToken = $o['TurnstileToken'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SchedulerUrl)) $o['SchedulerUrl'] = $this->SchedulerUrl;
        if (isset($this->Address)) $o['Address'] = $this->Address;
        if (isset($this->Unit)) $o['Unit'] = $this->Unit;
        if (isset($this->City)) $o['City'] = $this->City;
        if (isset($this->Zip)) $o['Zip'] = $this->Zip;
        if (isset($this->Zone)) $o['Zone'] = $this->Zone;
        if (isset($this->Bags)) $o['Bags'] = $this->Bags;
        if (isset($this->Needs)) $o['Needs'] = JsonConverters::toArray('string', $this->Needs);
        if (isset($this->Note)) $o['Note'] = $this->Note;
        if (isset($this->CustomerName)) $o['CustomerName'] = $this->CustomerName;
        if (isset($this->CustomerPhone)) $o['CustomerPhone'] = $this->CustomerPhone;
        if (isset($this->PayMode)) $o['PayMode'] = $this->PayMode;
        if (isset($this->AccountCode)) $o['AccountCode'] = $this->AccountCode;
        if (isset($this->TurnstileToken)) $o['TurnstileToken'] = $this->TurnstileToken;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DispatchPickupBookRequest 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/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchPickupBookRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AccountCode>String</AccountCode>
  <Address>String</Address>
  <Bags>0</Bags>
  <City>String</City>
  <CustomerName>String</CustomerName>
  <CustomerPhone>String</CustomerPhone>
  <Needs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Needs>
  <Note>String</Note>
  <PayMode>String</PayMode>
  <SchedulerUrl>String</SchedulerUrl>
  <TurnstileToken>String</TurnstileToken>
  <Unit>String</Unit>
  <Zip>String</Zip>
  <Zone>String</Zone>
</DispatchPickupBookRequest>

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

<DispatchPickupBookResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Bags>0</Bags>
  <BookToken>String</BookToken>
  <ClientSecret>String</ClientSecret>
  <Code>String</Code>
  <Delivery>String</Delivery>
  <Fare>0</Fare>
  <PayLine>String</PayLine>
  <PayMode>String</PayMode>
  <PublishableKey>String</PublishableKey>
  <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>
  <TrackUrl>String</TrackUrl>
  <Zone>String</Zone>
</DispatchPickupBookResponse>