Trendsic Platform Service

<back to all web services

AgentHierarchyRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentHierarchyById/{AgentNumber}
GET,OPTIONS/v1/AgentHierarchy
"use strict";
export class AgentHierarchy {
    /** @param {{PackageCost?:string,Package?:string,AgentNumber?:string,PlacementAgent?:string,Company?:string,FirstName?:string,LastName?:string,MiddleInitial?:string,Email?:string,HomePhone?:string,CellPhone?:string,WorkPhone?:string,Level?:string,label?:string,AgentId?:number,AgentStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PackageCost;
    /** @type {string} */
    Package;
    /** @type {string} */
    AgentNumber;
    /** @type {string} */
    PlacementAgent;
    /** @type {string} */
    Company;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    MiddleInitial;
    /** @type {string} */
    Email;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    WorkPhone;
    /** @type {string} */
    Level;
    /** @type {string} */
    label;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentStatus;
}
export class AgentHierarchyResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentHierarchy?:AgentHierarchy[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentHierarchy[]} */
    AgentHierarchy = [];
}
export class AgentHierarchyRequest {
    /** @param {{AgentNumber?:string,IncludeInactive?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AgentNumber;
    /** @type {boolean} */
    IncludeInactive;
}

JavaScript AgentHierarchyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/AgentHierarchyById/{AgentNumber} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AgentHierarchy":[{"PackageCost":"String","Package":"String","AgentNumber":"String","PlacementAgent":"String","Company":"String","FirstName":"String","LastName":"String","MiddleInitial":"String","Email":"String","HomePhone":"String","CellPhone":"String","WorkPhone":"String","Level":"String","label":"String","AgentId":0,"AgentStatus":"String"}]}