Trendsic Platform Service

AgentRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator, Worker, Agent, Administrator

The following routes are available for this service:
GET	/v1/Agent/{AgentId}
GET,POST,PUT,DELETE,OPTIONS	/v1/Agent
GET	/v1/Agent/ByUserId/{UserId}
GET,POST,PUT,DELETE,OPTIONS	/v1/Agent/Hierarchy/{ParamGetHierarchy}
GET,OPTIONS	/v1/Agent/Hierarchy/{ParamGetHierarchy}/{ParamDistinct}/{NewAgents}
GET,OPTIONS	/v1/Agent/Hierarchy/{ParamGetHierarchy}/{ParamDistinct}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class AgentRequest
{
    open var Agent:ArrayList<Agent> = ArrayList<Agent>()
    open var ParamGetHierarchy:Boolean? = null
    open var ParamDistinct:Boolean? = null
    open var NewAgents:Boolean? = null
    open var AgentId:Int? = null
    open var Location:UUID? = null
    open var UserId:UUID? = null
    open var Services:ArrayList<String> = ArrayList<String>()
}

open class Agent
{
    open var AgentId:Int? = null
    open var Company:String? = null
    open var AgentName:String? = null
    open var FirstName:String? = null
    open var LastName:String? = null
    open var MiddleInitial:String? = null
    open var Address1:String? = null
    open var Address2:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Zip:String? = null
    open var Country:String? = null
    open var Email:String? = null
    open var EmailSignature:String? = null
    open var HomePhone:String? = null
    open var CellPhone:String? = null
    open var WorkPhone:String? = null
    open var InsLicensed:Boolean? = null
    open var AgreeToDisclosures:Boolean? = null
    open var AgreeToDate:Date? = null
    open var PaidDate:Date? = null
    open var AgentNumber:String? = null
    open var ReferringAgent:String? = null
    open var PlacementAgent:String? = null
    open var CreatedDate:Date? = null
    open var UserId:UUID? = null
    open var IsAgent:Boolean? = null
    open var Package:String? = null
    open var StoreName:String? = null
    open var Notes:String? = null
    open var Upline1:Int? = null
    open var Upline2:Int? = null
    open var Upline3:Int? = null
    open var Upline4:Int? = null
    open var MVPID:Int? = null
    open var AVPID:Int? = null
    open var RVPID:Int? = null
    open var AgentLevel:BigDecimal? = null
    open var IsMVP:Boolean? = null
    open var IsRVP:Boolean? = null
    open var IsAVP:Boolean? = null
    open var IsAdmin:Boolean? = null
    open var IsBusinessCardAdmin:Boolean? = null
    open var TeamName:String? = null
    open var LocationId:UUID? = null
    open var CalendarId:UUID? = null
    open var Rank:String? = null
    open var NBC:Boolean? = null
    open var Upline1Percent:BigDecimal? = null
    open var Upline2Percent:BigDecimal? = null
    open var Upline3Percent:BigDecimal? = null
    open var Upline4Percent:BigDecimal? = null
    open var AgentStatus:String? = null
    open var Office:String? = null
    open var DOB:Date? = null
    open var SSN:String? = null
    open var Fax:String? = null
    open var BusinessEmail:String? = null
    open var ModifiedDate:Date? = null
    open var ModifiedBy:String? = null
    open var TimeZone:String? = null
    open var LeaderLocked:Boolean? = null
    open var LastSubmittedBusinessDate:Date? = null
    open var GracePeriodDate:Date? = null
    open var Vested:Boolean? = null
    open var DirectPay:Date? = null
    open var DirectPayApprBy:String? = null
    open var FactFinderBilling:BigDecimal? = null
    open var FullName:String? = null
    open var ByLastName:String? = null
    open var IsSecurityLicensed:Boolean? = null
    open var IsEncompassAdmin:Boolean? = null
    open var ApiKey:UUID? = null
    open var LastSessionId:String? = null
    open var LastLogin:Date? = null
    open var MfaActive:Boolean? = null
    open var RequireMFA:Boolean? = null
    open var SMSPhoneNumber:String? = null
    open var VerifiedEmailStatus:Boolean? = null
    open var VerifiedCellPhoneStatus:Boolean? = null
    open var SchedulerUrl:String? = null
    open var QueueDefaults:QueueDefault? = null
    open var Roles:ArrayList<String> = ArrayList<String>()
    open var PasswordUpdated:Boolean? = null
    open var RestrictToSingleSession:Boolean? = null
}

open class QueueDefault
{
    open var LocationId:UUID? = null
    open var Services:ArrayList<UUID> = ArrayList<UUID>()
}

open class AgentResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Agent:ArrayList<Agent> = ArrayList<Agent>()
}

Kotlin AgentRequest 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.

POST /v1/Agent HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Agent: 
	[
		{
			AgentId: 0,
			Company: String,
			AgentName: String,
			FirstName: String,
			LastName: String,
			MiddleInitial: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Country: String,
			Email: String,
			EmailSignature: String,
			HomePhone: String,
			CellPhone: String,
			WorkPhone: String,
			InsLicensed: False,
			AgreeToDisclosures: False,
			AgreeToDate: 0001-01-01,
			PaidDate: 0001-01-01,
			AgentNumber: String,
			ReferringAgent: String,
			PlacementAgent: String,
			CreatedDate: 0001-01-01,
			UserId: 00000000000000000000000000000000,
			IsAgent: False,
			Package: String,
			StoreName: String,
			Notes: String,
			Upline1: 0,
			Upline2: 0,
			Upline3: 0,
			Upline4: 0,
			MVPID: 0,
			AVPID: 0,
			RVPID: 0,
			AgentLevel: 0,
			IsMVP: False,
			IsRVP: False,
			IsAVP: False,
			IsAdmin: False,
			IsBusinessCardAdmin: False,
			TeamName: String,
			LocationId: 00000000000000000000000000000000,
			CalendarId: 00000000000000000000000000000000,
			Rank: String,
			NBC: False,
			Upline1Percent: 0,
			Upline2Percent: 0,
			Upline3Percent: 0,
			Upline4Percent: 0,
			AgentStatus: String,
			Office: String,
			DOB: 0001-01-01,
			SSN: String,
			Fax: String,
			BusinessEmail: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String,
			TimeZone: String,
			LeaderLocked: False,
			LastSubmittedBusinessDate: 0001-01-01,
			GracePeriodDate: 0001-01-01,
			Vested: False,
			DirectPay: 0001-01-01,
			DirectPayApprBy: String,
			FactFinderBilling: 0,
			FullName: String,
			ByLastName: String,
			IsSecurityLicensed: False,
			IsEncompassAdmin: False,
			ApiKey: 00000000000000000000000000000000,
			LastSessionId: String,
			LastLogin: 0001-01-01,
			MfaActive: False,
			RequireMFA: False,
			SMSPhoneNumber: String,
			VerifiedEmailStatus: False,
			VerifiedCellPhoneStatus: False,
			SchedulerUrl: String,
			QueueDefaults: 
			{
				LocationId: 00000000000000000000000000000000,
				Services: 
				[
					00000000000000000000000000000000
				]
			},
			Roles: 
			[
				String
			],
			PasswordUpdated: False,
			RestrictToSingleSession: False
		}
	],
	ParamGetHierarchy: False,
	ParamDistinct: False,
	NewAgents: False,
	AgentId: 0,
	Location: 00000000000000000000000000000000,
	UserId: 00000000000000000000000000000000,
	Services: 
	[
		String
	]
}

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
		}
	},
	Agent: 
	[
		{
			AgentId: 0,
			Company: String,
			AgentName: String,
			FirstName: String,
			LastName: String,
			MiddleInitial: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Country: String,
			Email: String,
			EmailSignature: String,
			HomePhone: String,
			CellPhone: String,
			WorkPhone: String,
			InsLicensed: False,
			AgreeToDisclosures: False,
			AgreeToDate: 0001-01-01,
			PaidDate: 0001-01-01,
			AgentNumber: String,
			ReferringAgent: String,
			PlacementAgent: String,
			CreatedDate: 0001-01-01,
			UserId: 00000000000000000000000000000000,
			IsAgent: False,
			Package: String,
			StoreName: String,
			Notes: String,
			Upline1: 0,
			Upline2: 0,
			Upline3: 0,
			Upline4: 0,
			MVPID: 0,
			AVPID: 0,
			RVPID: 0,
			AgentLevel: 0,
			IsMVP: False,
			IsRVP: False,
			IsAVP: False,
			IsAdmin: False,
			IsBusinessCardAdmin: False,
			TeamName: String,
			LocationId: 00000000000000000000000000000000,
			CalendarId: 00000000000000000000000000000000,
			Rank: String,
			NBC: False,
			Upline1Percent: 0,
			Upline2Percent: 0,
			Upline3Percent: 0,
			Upline4Percent: 0,
			AgentStatus: String,
			Office: String,
			DOB: 0001-01-01,
			SSN: String,
			Fax: String,
			BusinessEmail: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String,
			TimeZone: String,
			LeaderLocked: False,
			LastSubmittedBusinessDate: 0001-01-01,
			GracePeriodDate: 0001-01-01,
			Vested: False,
			DirectPay: 0001-01-01,
			DirectPayApprBy: String,
			FactFinderBilling: 0,
			FullName: String,
			ByLastName: String,
			IsSecurityLicensed: False,
			IsEncompassAdmin: False,
			ApiKey: 00000000000000000000000000000000,
			LastSessionId: String,
			LastLogin: 0001-01-01,
			MfaActive: False,
			RequireMFA: False,
			SMSPhoneNumber: String,
			VerifiedEmailStatus: False,
			VerifiedCellPhoneStatus: False,
			SchedulerUrl: String,
			QueueDefaults: 
			{
				LocationId: 00000000000000000000000000000000,
				Services: 
				[
					00000000000000000000000000000000
				]
			},
			Roles: 
			[
				String
			],
			PasswordUpdated: False,
			RestrictToSingleSession: False
		}
	]
}