Trendsic Platform Service

WorkerMessagesRequest

The following routes are available for this service:
GET,POST,OPTIONS	/v1/worker/messages

<?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 WorkerCrew implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CrewID=0,
        /** @var string|null */
        public ?string $CrewName=null,
        /** @var bool|null */
        public ?bool $IsManager=null
    ) {
    }

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

class WorkerCrewMessage implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CrewMessageID=0,
        /** @var int */
        public int $CrewID=0,
        /** @var string|null */
        public ?string $CrewName=null,
        /** @var int */
        public int $SenderContactID=0,
        /** @var string|null */
        public ?string $SenderName=null,
        /** @var string|null */
        public ?string $Body=null,
        /** @var bool|null */
        public ?bool $IsAlert=null,
        /** @var string|null */
        public ?string $CreatedAtLabel=null,
        /** @var bool|null */
        public ?bool $Mine=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CrewMessageID'])) $this->CrewMessageID = $o['CrewMessageID'];
        if (isset($o['CrewID'])) $this->CrewID = $o['CrewID'];
        if (isset($o['CrewName'])) $this->CrewName = $o['CrewName'];
        if (isset($o['SenderContactID'])) $this->SenderContactID = $o['SenderContactID'];
        if (isset($o['SenderName'])) $this->SenderName = $o['SenderName'];
        if (isset($o['Body'])) $this->Body = $o['Body'];
        if (isset($o['IsAlert'])) $this->IsAlert = $o['IsAlert'];
        if (isset($o['CreatedAtLabel'])) $this->CreatedAtLabel = $o['CreatedAtLabel'];
        if (isset($o['Mine'])) $this->Mine = $o['Mine'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CrewMessageID)) $o['CrewMessageID'] = $this->CrewMessageID;
        if (isset($this->CrewID)) $o['CrewID'] = $this->CrewID;
        if (isset($this->CrewName)) $o['CrewName'] = $this->CrewName;
        if (isset($this->SenderContactID)) $o['SenderContactID'] = $this->SenderContactID;
        if (isset($this->SenderName)) $o['SenderName'] = $this->SenderName;
        if (isset($this->Body)) $o['Body'] = $this->Body;
        if (isset($this->IsAlert)) $o['IsAlert'] = $this->IsAlert;
        if (isset($this->CreatedAtLabel)) $o['CreatedAtLabel'] = $this->CreatedAtLabel;
        if (isset($this->Mine)) $o['Mine'] = $this->Mine;
        return empty($o) ? new class(){} : $o;
    }
}

class WorkerMessagesResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<WorkerCrew>|null */
        public ?array $Crews=null,
        /** @var array<WorkerCrewMessage>|null */
        public ?array $Messages=null,
        /** @var bool|null */
        public ?bool $Sent=null
    ) {
    }

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

class WorkerMessagesRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CrewID=0,
        /** @var string|null */
        public ?string $Body=null,
        /** @var bool|null */
        public ?bool $IsAlert=null
    ) {
    }

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

PHP WorkerMessagesRequest 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/worker/messages HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WorkerMessagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Body>String</Body>
  <CrewID>0</CrewID>
  <IsAlert>false</IsAlert>
</WorkerMessagesRequest>

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

<WorkerMessagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Crews>
    <WorkerCrew>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
      <IsManager>false</IsManager>
    </WorkerCrew>
  </Crews>
  <Messages>
    <WorkerCrewMessage>
      <Body>String</Body>
      <CreatedAtLabel>String</CreatedAtLabel>
      <CrewID>0</CrewID>
      <CrewMessageID>0</CrewMessageID>
      <CrewName>String</CrewName>
      <IsAlert>false</IsAlert>
      <Mine>false</Mine>
      <SenderContactID>0</SenderContactID>
      <SenderName>String</SenderName>
    </WorkerCrewMessage>
  </Messages>
  <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>
  <Sent>false</Sent>
</WorkerMessagesResponse>