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}

export class AgentCategorization
{
    public AgentId: number;
    public AgentFirstName: string;
    public AgentLastName: string;
    public ContactId: number;
    public ContactGUID: string;
    public ContactFirstName: string;
    public ContactLastName: string;
    public ContactStatus: number;
    public ContactStatusName: string;
    public ContactCategory: number;
    public ContactCategoryName: string;
    public ContactEmail: string;
    public ContactPhone: string;
    public IsShared: boolean;
    public WritingAgentId: number;
    public IsWritingAgent: boolean;
    public WritingAgentName: string;

    public constructor(init?: Partial<AgentCategorization>) { (Object as any).assign(this, init); }
}

export class AgentCategorizationResponse
{
    public ResponseStatus: ResponseStatus;
    public Contacts: AgentCategorization[] = [];

    public constructor(init?: Partial<AgentCategorizationResponse>) { (Object as any).assign(this, init); }
}

export class AgentCategorizationRequest
{
    public AgentId: number;
    public ContactCategoryId: number;

    public constructor(init?: Partial<AgentCategorizationRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	]
}