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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}