| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/AgentHierarchyById/{AgentNumber} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/AgentHierarchy |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentNumber | path | string | No | |
| IncludeInactive | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| AgentHierarchy | form | List<AgentHierarchy> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PackageCost | form | string | No | |
| Package | form | string | No | |
| AgentNumber | form | string | No | |
| PlacementAgent | form | string | No | |
| Company | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| MiddleInitial | form | string | No | |
| form | string | No | ||
| HomePhone | form | string | No | |
| CellPhone | form | string | No | |
| WorkPhone | form | string | No | |
| Level | form | string | No | |
| label | form | string | No | |
| AgentId | form | int | No | |
| AgentStatus | form | string | No |
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
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"}]}