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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class AgentHierarchyRequest
    {
        public String AgentNumber = null;
        public Boolean IncludeInactive = null;
        
        public String getAgentNumber() { return AgentNumber; }
        public AgentHierarchyRequest setAgentNumber(String value) { this.AgentNumber = value; return this; }
        public Boolean isIncludeInactive() { return IncludeInactive; }
        public AgentHierarchyRequest setIncludeInactive(Boolean value) { this.IncludeInactive = value; return this; }
    }

    public static class AgentHierarchyResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<AgentHierarchy> AgentHierarchy = new ArrayList<AgentHierarchy>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AgentHierarchyResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<AgentHierarchy> getAgentHierarchy() { return AgentHierarchy; }
        public AgentHierarchyResponse setAgentHierarchy(ArrayList<AgentHierarchy> value) { this.AgentHierarchy = value; return this; }
    }

    public static class AgentHierarchy
    {
        public String PackageCost = null;
        public String Package = null;
        public String AgentNumber = null;
        public String PlacementAgent = null;
        public String Company = null;
        public String FirstName = null;
        public String LastName = null;
        public String MiddleInitial = null;
        public String Email = null;
        public String HomePhone = null;
        public String CellPhone = null;
        public String WorkPhone = null;
        public String Level = null;
        public String label = null;
        public Integer AgentId = null;
        public String AgentStatus = null;
        
        public String getPackageCost() { return PackageCost; }
        public AgentHierarchy setPackageCost(String value) { this.PackageCost = value; return this; }
        public String getPackage() { return Package; }
        public AgentHierarchy setPackage(String value) { this.Package = value; return this; }
        public String getAgentNumber() { return AgentNumber; }
        public AgentHierarchy setAgentNumber(String value) { this.AgentNumber = value; return this; }
        public String getPlacementAgent() { return PlacementAgent; }
        public AgentHierarchy setPlacementAgent(String value) { this.PlacementAgent = value; return this; }
        public String getCompany() { return Company; }
        public AgentHierarchy setCompany(String value) { this.Company = value; return this; }
        public String getFirstName() { return FirstName; }
        public AgentHierarchy setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public AgentHierarchy setLastName(String value) { this.LastName = value; return this; }
        public String getMiddleInitial() { return MiddleInitial; }
        public AgentHierarchy setMiddleInitial(String value) { this.MiddleInitial = value; return this; }
        public String getEmail() { return Email; }
        public AgentHierarchy setEmail(String value) { this.Email = value; return this; }
        public String getHomePhone() { return HomePhone; }
        public AgentHierarchy setHomePhone(String value) { this.HomePhone = value; return this; }
        public String getCellPhone() { return CellPhone; }
        public AgentHierarchy setCellPhone(String value) { this.CellPhone = value; return this; }
        public String getWorkPhone() { return WorkPhone; }
        public AgentHierarchy setWorkPhone(String value) { this.WorkPhone = value; return this; }
        public String getLevel() { return Level; }
        public AgentHierarchy setLevel(String value) { this.Level = value; return this; }
        public String getLabel() { return label; }
        public AgentHierarchy setLabel(String value) { this.label = value; return this; }
        public Integer getAgentId() { return AgentId; }
        public AgentHierarchy setAgentId(Integer value) { this.AgentId = value; return this; }
        public String getAgentStatus() { return AgentStatus; }
        public AgentHierarchy setAgentStatus(String value) { this.AgentStatus = value; return this; }
    }

}

Java AgentHierarchyRequest DTOs

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentHierarchyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentHierarchy>
    <AgentHierarchy>
      <AgentId>0</AgentId>
      <AgentNumber>String</AgentNumber>
      <AgentStatus>String</AgentStatus>
      <CellPhone>String</CellPhone>
      <Company>String</Company>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <HomePhone>String</HomePhone>
      <LastName>String</LastName>
      <Level>String</Level>
      <MiddleInitial>String</MiddleInitial>
      <Package>String</Package>
      <PackageCost>String</PackageCost>
      <PlacementAgent>String</PlacementAgent>
      <WorkPhone>String</WorkPhone>
      <label>String</label>
    </AgentHierarchy>
  </AgentHierarchy>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AgentHierarchyResponse>