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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Contacts: 
	[
		{
			AgentId: 0,
			AgentFirstName: String,
			AgentLastName: String,
			ContactId: 0,
			ContactGUID: 00000000000000000000000000000000,
			ContactFirstName: String,
			ContactLastName: String,
			ContactStatus: 0,
			ContactStatusName: String,
			ContactCategory: 0,
			ContactCategoryName: String,
			ContactEmail: String,
			ContactPhone: String,
			IsShared: False,
			WritingAgentId: 0,
			IsWritingAgent: False,
			WritingAgentName: String
		}
	]
}