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 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 .jsv suffix or ?format=jsv

HTTP + JSV

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