Trendsic Platform Service

<back to all web services

MessagingEvaluateRequest

The following routes are available for this service:
POST/v1/messaging/evaluate
<?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 Report implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Tenants=0,
        /** @var int */
        public int $AlmostUpPublished=0,
        /** @var int */
        public int $RunningBehindPublished=0,
        /** @var int */
        public int $BranchesSwept=0,
        /** @var int */
        public int $RollupsRebuilt=0,
        /** @var int */
        public int $RetriesSent=0,
        /** @var array<string>|null */
        public ?array $Problems=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Tenants'])) $this->Tenants = $o['Tenants'];
        if (isset($o['AlmostUpPublished'])) $this->AlmostUpPublished = $o['AlmostUpPublished'];
        if (isset($o['RunningBehindPublished'])) $this->RunningBehindPublished = $o['RunningBehindPublished'];
        if (isset($o['BranchesSwept'])) $this->BranchesSwept = $o['BranchesSwept'];
        if (isset($o['RollupsRebuilt'])) $this->RollupsRebuilt = $o['RollupsRebuilt'];
        if (isset($o['RetriesSent'])) $this->RetriesSent = $o['RetriesSent'];
        if (isset($o['Problems'])) $this->Problems = JsonConverters::fromArray('string', $o['Problems']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Tenants)) $o['Tenants'] = $this->Tenants;
        if (isset($this->AlmostUpPublished)) $o['AlmostUpPublished'] = $this->AlmostUpPublished;
        if (isset($this->RunningBehindPublished)) $o['RunningBehindPublished'] = $this->RunningBehindPublished;
        if (isset($this->BranchesSwept)) $o['BranchesSwept'] = $this->BranchesSwept;
        if (isset($this->RollupsRebuilt)) $o['RollupsRebuilt'] = $this->RollupsRebuilt;
        if (isset($this->RetriesSent)) $o['RetriesSent'] = $this->RetriesSent;
        if (isset($this->Problems)) $o['Problems'] = JsonConverters::toArray('string', $this->Problems);
        return empty($o) ? new class(){} : $o;
    }
}

class MessagingEvaluateResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var Report|null */
        public ?Report $Report=null
    ) {
    }

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

class MessagingEvaluateRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

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

<MessagingEvaluateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessagingEvaluateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Report>
    <AlmostUpPublished>0</AlmostUpPublished>
    <BranchesSwept>0</BranchesSwept>
    <Problems xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Problems>
    <RetriesSent>0</RetriesSent>
    <RollupsRebuilt>0</RollupsRebuilt>
    <RunningBehindPublished>0</RunningBehindPublished>
    <Tenants>0</Tenants>
  </Report>
  <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>
</MessagingEvaluateResponse>