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

export class AgentHierarchy
{
    public PackageCost: string;
    public Package: string;
    public AgentNumber: string;
    public PlacementAgent: string;
    public Company: string;
    public FirstName: string;
    public LastName: string;
    public MiddleInitial: string;
    public Email: string;
    public HomePhone: string;
    public CellPhone: string;
    public WorkPhone: string;
    public Level: string;
    public label: string;
    public AgentId: number;
    public AgentStatus: string;

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

export class AgentHierarchyResponse
{
    public ResponseStatus: ResponseStatus;
    public AgentHierarchy: AgentHierarchy[] = [];

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

export class AgentHierarchyRequest
{
    public AgentNumber: string;
    public IncludeInactive: boolean;

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

TypeScript AgentHierarchyRequest 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/AgentHierarchyById/{AgentNumber} 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
		}
	},
	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
		}
	]
}