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
import Foundation
import ServiceStack

public class AgentHierarchyRequest : Codable
{
    public var agentNumber:String
    public var includeInactive:Bool

    required public init(){}
}

public class AgentHierarchyResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var agentHierarchy:[AgentHierarchy] = []

    required public init(){}
}

public class AgentHierarchy : Codable
{
    public var packageCost:String
    public var package:String
    public var agentNumber:String
    public var placementAgent:String
    public var company:String
    public var firstName:String
    public var lastName:String
    public var middleInitial:String
    public var email:String
    public var homePhone:String
    public var cellPhone:String
    public var workPhone:String
    public var level:String
    public var label:String
    public var agentId:Int
    public var agentStatus:String

    required public init(){}
}


Swift AgentHierarchyRequest DTOs

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

HTTP + OTHER

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