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
ReferralHierarchyRequest Parameters:
NameParameterData TypeRequiredDescription
AgentHierarchyqueryList<AgentHierarchy>No
AgentHierarchy Parameters:
NameParameterData TypeRequiredDescription
PackageCostformstringNo
PackageformstringNo
AgentNumberformstringNo
PlacementAgentformstringNo
CompanyformstringNo
FirstNameformstringNo
LastNameformstringNo
MiddleInitialformstringNo
EmailformstringNo
HomePhoneformstringNo
CellPhoneformstringNo
WorkPhoneformstringNo
LevelformstringNo
labelformstringNo
AgentIdformintNo
AgentStatusformstringNo
ReferralHierarchyResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AgentHierarchyformList<AgentHierarchy>No

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/ReferralHierarchy 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
		}
	]
}