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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AgentCategorization() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val AgentFirstName:String = null with get,set
        member val AgentLastName:String = null with get,set
        member val ContactId:Int32 = new Int32() with get,set
        member val ContactGUID:Guid = new Guid() with get,set
        member val ContactFirstName:String = null with get,set
        member val ContactLastName:String = null with get,set
        member val ContactStatus:Int32 = new Int32() with get,set
        member val ContactStatusName:String = null with get,set
        member val ContactCategory:Int32 = new Int32() with get,set
        member val ContactCategoryName:String = null with get,set
        member val ContactEmail:String = null with get,set
        member val ContactPhone:String = null with get,set
        member val IsShared:Boolean = new Boolean() with get,set
        member val WritingAgentId:Int32 = new Int32() with get,set
        member val IsWritingAgent:Boolean = new Boolean() with get,set
        member val WritingAgentName:String = null with get,set

    [<AllowNullLiteral>]
    type AgentCategorizationResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Contacts:ResizeArray<AgentCategorization> = new ResizeArray<AgentCategorization>() with get,set

    [<AllowNullLiteral>]
    type AgentCategorizationRequest() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val ContactCategoryId:Int32 = new Int32() with get,set

F# 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>