Trendsic Platform Service

<back to all web services

AgentCategorizationRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Report/AgentCategorization/{AgentId}/
GET,OPTIONS/v1/Report/AgentCategorization/{AgentId}/{ContactCategoryId}
<?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 AgentCategorization implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $AgentFirstName=null,
        /** @var string|null */
        public ?string $AgentLastName=null,
        /** @var int */
        public int $ContactId=0,
        /** @var string */
        public string $ContactGUID='',
        /** @var string|null */
        public ?string $ContactFirstName=null,
        /** @var string|null */
        public ?string $ContactLastName=null,
        /** @var int */
        public int $ContactStatus=0,
        /** @var string|null */
        public ?string $ContactStatusName=null,
        /** @var int */
        public int $ContactCategory=0,
        /** @var string|null */
        public ?string $ContactCategoryName=null,
        /** @var string|null */
        public ?string $ContactEmail=null,
        /** @var string|null */
        public ?string $ContactPhone=null,
        /** @var bool|null */
        public ?bool $IsShared=null,
        /** @var int */
        public int $WritingAgentId=0,
        /** @var bool|null */
        public ?bool $IsWritingAgent=null,
        /** @var string|null */
        public ?string $WritingAgentName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['AgentFirstName'])) $this->AgentFirstName = $o['AgentFirstName'];
        if (isset($o['AgentLastName'])) $this->AgentLastName = $o['AgentLastName'];
        if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
        if (isset($o['ContactGUID'])) $this->ContactGUID = $o['ContactGUID'];
        if (isset($o['ContactFirstName'])) $this->ContactFirstName = $o['ContactFirstName'];
        if (isset($o['ContactLastName'])) $this->ContactLastName = $o['ContactLastName'];
        if (isset($o['ContactStatus'])) $this->ContactStatus = $o['ContactStatus'];
        if (isset($o['ContactStatusName'])) $this->ContactStatusName = $o['ContactStatusName'];
        if (isset($o['ContactCategory'])) $this->ContactCategory = $o['ContactCategory'];
        if (isset($o['ContactCategoryName'])) $this->ContactCategoryName = $o['ContactCategoryName'];
        if (isset($o['ContactEmail'])) $this->ContactEmail = $o['ContactEmail'];
        if (isset($o['ContactPhone'])) $this->ContactPhone = $o['ContactPhone'];
        if (isset($o['IsShared'])) $this->IsShared = $o['IsShared'];
        if (isset($o['WritingAgentId'])) $this->WritingAgentId = $o['WritingAgentId'];
        if (isset($o['IsWritingAgent'])) $this->IsWritingAgent = $o['IsWritingAgent'];
        if (isset($o['WritingAgentName'])) $this->WritingAgentName = $o['WritingAgentName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->AgentFirstName)) $o['AgentFirstName'] = $this->AgentFirstName;
        if (isset($this->AgentLastName)) $o['AgentLastName'] = $this->AgentLastName;
        if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
        if (isset($this->ContactGUID)) $o['ContactGUID'] = $this->ContactGUID;
        if (isset($this->ContactFirstName)) $o['ContactFirstName'] = $this->ContactFirstName;
        if (isset($this->ContactLastName)) $o['ContactLastName'] = $this->ContactLastName;
        if (isset($this->ContactStatus)) $o['ContactStatus'] = $this->ContactStatus;
        if (isset($this->ContactStatusName)) $o['ContactStatusName'] = $this->ContactStatusName;
        if (isset($this->ContactCategory)) $o['ContactCategory'] = $this->ContactCategory;
        if (isset($this->ContactCategoryName)) $o['ContactCategoryName'] = $this->ContactCategoryName;
        if (isset($this->ContactEmail)) $o['ContactEmail'] = $this->ContactEmail;
        if (isset($this->ContactPhone)) $o['ContactPhone'] = $this->ContactPhone;
        if (isset($this->IsShared)) $o['IsShared'] = $this->IsShared;
        if (isset($this->WritingAgentId)) $o['WritingAgentId'] = $this->WritingAgentId;
        if (isset($this->IsWritingAgent)) $o['IsWritingAgent'] = $this->IsWritingAgent;
        if (isset($this->WritingAgentName)) $o['WritingAgentName'] = $this->WritingAgentName;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class AgentCategorizationRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var int */
        public int $ContactCategoryId=0
    ) {
    }

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

PHP AgentCategorizationRequest 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/AgentCategorization/{AgentId}/ HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<AgentCategorizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Contacts>
    <AgentCategorization>
      <AgentFirstName>String</AgentFirstName>
      <AgentId>0</AgentId>
      <AgentLastName>String</AgentLastName>
      <ContactCategory>0</ContactCategory>
      <ContactCategoryName>String</ContactCategoryName>
      <ContactEmail>String</ContactEmail>
      <ContactFirstName>String</ContactFirstName>
      <ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
      <ContactId>0</ContactId>
      <ContactLastName>String</ContactLastName>
      <ContactPhone>String</ContactPhone>
      <ContactStatus>0</ContactStatus>
      <ContactStatusName>String</ContactStatusName>
      <IsShared>false</IsShared>
      <IsWritingAgent>false</IsWritingAgent>
      <WritingAgentId>0</WritingAgentId>
      <WritingAgentName>String</WritingAgentName>
    </AgentCategorization>
  </Contacts>
  <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>
</AgentCategorizationResponse>