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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AgentHierarchy() = 
        member val PackageCost:String = null with get,set
        member val Package:String = null with get,set
        member val AgentNumber:String = null with get,set
        member val PlacementAgent:String = null with get,set
        member val Company:String = null with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val MiddleInitial:String = null with get,set
        member val Email:String = null with get,set
        member val HomePhone:String = null with get,set
        member val CellPhone:String = null with get,set
        member val WorkPhone:String = null with get,set
        member val Level:String = null with get,set
        member val label:String = null with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val AgentStatus:String = null with get,set

    [<AllowNullLiteral>]
    type AgentHierarchyResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val AgentHierarchy:ResizeArray<AgentHierarchy> = new ResizeArray<AgentHierarchy>() with get,set

    [<AllowNullLiteral>]
    type AgentHierarchyRequest() = 
        member val AgentNumber:String = null with get,set
        member val IncludeInactive:Boolean = new Boolean() with get,set

F# 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
		}
	]
}