Trendsic Platform Service

<back to all web services

ContactCategorizationRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Report/ContactCategorization
<?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 ContactCategorization implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $FirstName=null,
        /** @var string|null */
        public ?string $LastName=null,
        /** @var string|null */
        public ?string $AgentStatus=null,
        /** @var int */
        public int $TotalContacts=0,
        /** @var int */
        public int $TotalUncategorized=0,
        /** @var int */
        public int $TotalA=0,
        /** @var int */
        public int $TotalB=0,
        /** @var int */
        public int $TotalC=0,
        /** @var int */
        public int $TotalD=0,
        /** @var int */
        public int $TotalI=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
        if (isset($o['LastName'])) $this->LastName = $o['LastName'];
        if (isset($o['AgentStatus'])) $this->AgentStatus = $o['AgentStatus'];
        if (isset($o['TotalContacts'])) $this->TotalContacts = $o['TotalContacts'];
        if (isset($o['TotalUncategorized'])) $this->TotalUncategorized = $o['TotalUncategorized'];
        if (isset($o['TotalA'])) $this->TotalA = $o['TotalA'];
        if (isset($o['TotalB'])) $this->TotalB = $o['TotalB'];
        if (isset($o['TotalC'])) $this->TotalC = $o['TotalC'];
        if (isset($o['TotalD'])) $this->TotalD = $o['TotalD'];
        if (isset($o['TotalI'])) $this->TotalI = $o['TotalI'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
        if (isset($this->LastName)) $o['LastName'] = $this->LastName;
        if (isset($this->AgentStatus)) $o['AgentStatus'] = $this->AgentStatus;
        if (isset($this->TotalContacts)) $o['TotalContacts'] = $this->TotalContacts;
        if (isset($this->TotalUncategorized)) $o['TotalUncategorized'] = $this->TotalUncategorized;
        if (isset($this->TotalA)) $o['TotalA'] = $this->TotalA;
        if (isset($this->TotalB)) $o['TotalB'] = $this->TotalB;
        if (isset($this->TotalC)) $o['TotalC'] = $this->TotalC;
        if (isset($this->TotalD)) $o['TotalD'] = $this->TotalD;
        if (isset($this->TotalI)) $o['TotalI'] = $this->TotalI;
        return empty($o) ? new class(){} : $o;
    }
}

class ContactCategorizationResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<ContactCategorization>|null */
        public ?array $ContactCategorizations=null
    ) {
    }

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

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

PHP ContactCategorizationRequest 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.

GET /v1/Report/ContactCategorization HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactCategorizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactCategorizations>
    <ContactCategorization>
      <AgentId>0</AgentId>
      <AgentStatus>String</AgentStatus>
      <FirstName>String</FirstName>
      <LastName>String</LastName>
      <TotalA>0</TotalA>
      <TotalB>0</TotalB>
      <TotalC>0</TotalC>
      <TotalContacts>0</TotalContacts>
      <TotalD>0</TotalD>
      <TotalI>0</TotalI>
      <TotalUncategorized>0</TotalUncategorized>
    </ContactCategorization>
  </ContactCategorizations>
  <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>
</ContactCategorizationResponse>