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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class AgentHierarchy
            Public Overridable Property PackageCost As String
            Public Overridable Property Package As String
            Public Overridable Property AgentNumber As String
            Public Overridable Property PlacementAgent As String
            Public Overridable Property Company As String
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property MiddleInitial As String
            Public Overridable Property Email As String
            Public Overridable Property HomePhone As String
            Public Overridable Property CellPhone As String
            Public Overridable Property WorkPhone As String
            Public Overridable Property Level As String
            Public Overridable Property label As String
            Public Overridable Property AgentId As Integer
            Public Overridable Property AgentStatus As String
        End Class

        Public Partial Class ReferralHierarchyRequest
            Public Overridable Property AgentHierarchy As List(Of AgentHierarchy) = New List(Of AgentHierarchy)
        End Class

        Public Partial Class ReferralHierarchyResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property AgentHierarchy As List(Of AgentHierarchy) = New List(Of AgentHierarchy)
        End Class
    End Namespace
End Namespace

VB.NET ReferralHierarchyRequest 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/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
		}
	]
}