Trendsic Platform Service

<back to all web services

DispatchCommsRequest

<?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 WorkerCommsView implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $MovingMph=0.0,
        /** @var int */
        public int $MovingHoldSecs=0,
        /** @var bool|null */
        public ?bool $RelayVoice=null,
        /** @var bool|null */
        public ?bool $RelayReady=null,
        /** @var bool|null */
        public ?bool $HasOwnNumber=null,
        /** @var string|null */
        public ?string $RelayNumber=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['MovingMph'])) $this->MovingMph = $o['MovingMph'];
        if (isset($o['MovingHoldSecs'])) $this->MovingHoldSecs = $o['MovingHoldSecs'];
        if (isset($o['RelayVoice'])) $this->RelayVoice = $o['RelayVoice'];
        if (isset($o['RelayReady'])) $this->RelayReady = $o['RelayReady'];
        if (isset($o['HasOwnNumber'])) $this->HasOwnNumber = $o['HasOwnNumber'];
        if (isset($o['RelayNumber'])) $this->RelayNumber = $o['RelayNumber'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->MovingMph)) $o['MovingMph'] = $this->MovingMph;
        if (isset($this->MovingHoldSecs)) $o['MovingHoldSecs'] = $this->MovingHoldSecs;
        if (isset($this->RelayVoice)) $o['RelayVoice'] = $this->RelayVoice;
        if (isset($this->RelayReady)) $o['RelayReady'] = $this->RelayReady;
        if (isset($this->HasOwnNumber)) $o['HasOwnNumber'] = $this->HasOwnNumber;
        if (isset($this->RelayNumber)) $o['RelayNumber'] = $this->RelayNumber;
        return empty($o) ? new class(){} : $o;
    }
}

class WorkerCommsResponse implements JsonSerializable
{
    public function __construct(
        /** @var WorkerCommsView|null */
        public ?WorkerCommsView $Comms=null,
        /** @var string|null */
        public ?string $Number=null,
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Comms'])) $this->Comms = JsonConverters::from('WorkerCommsView', $o['Comms']);
        if (isset($o['Number'])) $this->Number = $o['Number'];
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Comms)) $o['Comms'] = JsonConverters::to('WorkerCommsView', $this->Comms);
        if (isset($this->Number)) $o['Number'] = $this->Number;
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class DispatchCommsRequest implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $MovingMph=0.0,
        /** @var int */
        public int $MovingHoldSecs=0,
        /** @var bool|null */
        public ?bool $RelayVoice=null
    ) {
    }

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

PHP DispatchCommsRequest DTOs

PUT /v1/dispatch/comms HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchCommsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <MovingHoldSecs>0</MovingHoldSecs>
  <MovingMph>0</MovingMph>
  <RelayVoice>false</RelayVoice>
</DispatchCommsRequest>

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

<WorkerCommsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Code>String</Code>
  <Comms>
    <HasOwnNumber>false</HasOwnNumber>
    <MovingHoldSecs>0</MovingHoldSecs>
    <MovingMph>0</MovingMph>
    <RelayNumber>String</RelayNumber>
    <RelayReady>false</RelayReady>
    <RelayVoice>false</RelayVoice>
  </Comms>
  <Message>String</Message>
  <Number>String</Number>
  <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>
</WorkerCommsResponse>