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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class AgentCategorization
            Public Overridable Property AgentId As Integer
            Public Overridable Property AgentFirstName As String
            Public Overridable Property AgentLastName As String
            Public Overridable Property ContactId As Integer
            Public Overridable Property ContactGUID As Guid
            Public Overridable Property ContactFirstName As String
            Public Overridable Property ContactLastName As String
            Public Overridable Property ContactStatus As Integer
            Public Overridable Property ContactStatusName As String
            Public Overridable Property ContactCategory As Integer
            Public Overridable Property ContactCategoryName As String
            Public Overridable Property ContactEmail As String
            Public Overridable Property ContactPhone As String
            Public Overridable Property IsShared As Boolean
            Public Overridable Property WritingAgentId As Integer
            Public Overridable Property IsWritingAgent As Boolean
            Public Overridable Property WritingAgentName As String
        End Class

        Public Partial Class AgentCategorizationRequest
            Public Overridable Property AgentId As Integer
            Public Overridable Property ContactCategoryId As Integer
        End Class

        Public Partial Class AgentCategorizationResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Contacts As List(Of AgentCategorization) = New List(Of AgentCategorization)
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	]
}