Trendsic Platform Service

<back to all web services

DispatchPublicRequestCreate

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/public/request/{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 DispatchPublicRequestResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=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['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->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class DispatchPublicRequestCreate implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $SchedulerUrl=null,
        /** @var string|null */
        public ?string $CustomerName=null,
        /** @var string|null */
        public ?string $CustomerPhone=null,
        /** @var string|null */
        public ?string $CustomerEmail=null,
        /** @var string|null */
        public ?string $Cargo=null,
        /** @var int */
        public int $Units=0,
        /** @var string|null */
        public ?string $FromLoc=null,
        /** @var string|null */
        public ?string $ToLoc=null,
        /** @var string|null */
        public ?string $WindowText=null,
        /** @var bool|null */
        public ?bool $IsUrgent=null,
        /** @var string|null */
        public ?string $Notes=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['CustomerName'])) $this->CustomerName = $o['CustomerName'];
        if (isset($o['CustomerPhone'])) $this->CustomerPhone = $o['CustomerPhone'];
        if (isset($o['CustomerEmail'])) $this->CustomerEmail = $o['CustomerEmail'];
        if (isset($o['Cargo'])) $this->Cargo = $o['Cargo'];
        if (isset($o['Units'])) $this->Units = $o['Units'];
        if (isset($o['FromLoc'])) $this->FromLoc = $o['FromLoc'];
        if (isset($o['ToLoc'])) $this->ToLoc = $o['ToLoc'];
        if (isset($o['WindowText'])) $this->WindowText = $o['WindowText'];
        if (isset($o['IsUrgent'])) $this->IsUrgent = $o['IsUrgent'];
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
        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->CustomerName)) $o['CustomerName'] = $this->CustomerName;
        if (isset($this->CustomerPhone)) $o['CustomerPhone'] = $this->CustomerPhone;
        if (isset($this->CustomerEmail)) $o['CustomerEmail'] = $this->CustomerEmail;
        if (isset($this->Cargo)) $o['Cargo'] = $this->Cargo;
        if (isset($this->Units)) $o['Units'] = $this->Units;
        if (isset($this->FromLoc)) $o['FromLoc'] = $this->FromLoc;
        if (isset($this->ToLoc)) $o['ToLoc'] = $this->ToLoc;
        if (isset($this->WindowText)) $o['WindowText'] = $this->WindowText;
        if (isset($this->IsUrgent)) $o['IsUrgent'] = $this->IsUrgent;
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        if (isset($this->TurnstileToken)) $o['TurnstileToken'] = $this->TurnstileToken;
        return empty($o) ? new class(){} : $o;
    }
}

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

<DispatchPublicRequestCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Cargo>String</Cargo>
  <CustomerEmail>String</CustomerEmail>
  <CustomerName>String</CustomerName>
  <CustomerPhone>String</CustomerPhone>
  <FromLoc>String</FromLoc>
  <IsUrgent>false</IsUrgent>
  <Notes>String</Notes>
  <SchedulerUrl>String</SchedulerUrl>
  <ToLoc>String</ToLoc>
  <TurnstileToken>String</TurnstileToken>
  <Units>0</Units>
  <WindowText>String</WindowText>
</DispatchPublicRequestCreate>

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

<DispatchPublicRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Code>String</Code>
  <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>
</DispatchPublicRequestResponse>