Trendsic Platform Service

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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentHierarchy:
    package_cost: Optional[str] = None
    package: Optional[str] = None
    agent_number: Optional[str] = None
    placement_agent: Optional[str] = None
    company: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    middle_initial: Optional[str] = None
    email: Optional[str] = None
    home_phone: Optional[str] = None
    cell_phone: Optional[str] = None
    work_phone: Optional[str] = None
    level: Optional[str] = None
    label: Optional[str] = None
    agent_id: int = 0
    agent_status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentHierarchyResponse:
    response_status: Optional[ResponseStatus] = None
    agent_hierarchy: List[AgentHierarchy] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentHierarchyRequest:
    agent_number: Optional[str] = None
    include_inactive: bool = False

Python 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>