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}
"use strict";
export class AgentCategorization {
    /** @param {{AgentId?:number,AgentFirstName?:string,AgentLastName?:string,ContactId?:number,ContactGUID?:string,ContactFirstName?:string,ContactLastName?:string,ContactStatus?:number,ContactStatusName?:string,ContactCategory?:number,ContactCategoryName?:string,ContactEmail?:string,ContactPhone?:string,IsShared?:boolean,WritingAgentId?:number,IsWritingAgent?:boolean,WritingAgentName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentFirstName;
    /** @type {string} */
    AgentLastName;
    /** @type {number} */
    ContactId;
    /** @type {string} */
    ContactGUID;
    /** @type {string} */
    ContactFirstName;
    /** @type {string} */
    ContactLastName;
    /** @type {number} */
    ContactStatus;
    /** @type {string} */
    ContactStatusName;
    /** @type {number} */
    ContactCategory;
    /** @type {string} */
    ContactCategoryName;
    /** @type {string} */
    ContactEmail;
    /** @type {string} */
    ContactPhone;
    /** @type {boolean} */
    IsShared;
    /** @type {number} */
    WritingAgentId;
    /** @type {boolean} */
    IsWritingAgent;
    /** @type {string} */
    WritingAgentName;
}
export class AgentCategorizationResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Contacts?:AgentCategorization[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentCategorization[]} */
    Contacts = [];
}
export class AgentCategorizationRequest {
    /** @param {{AgentId?:number,ContactCategoryId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {number} */
    ContactCategoryId;
}

JavaScript 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>