Trendsic Platform Service

<back to all web services

ReferralHierarchyRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/ReferralHierarchy

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 ReferralHierarchyResponse
{
    public ResponseStatus: ResponseStatus;
    public AgentHierarchy: AgentHierarchy[] = [];

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

export class ReferralHierarchyRequest
{
    public AgentHierarchy: AgentHierarchy[] = [];

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

TypeScript ReferralHierarchyRequest 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/ReferralHierarchy HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReferralHierarchyResponse 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>
</ReferralHierarchyResponse>