Trendsic Platform Service

<back to all web services

AgentDistrictIdRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/DistrictAgents/{DistrictId}
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 QueueDefault() = 
        member val LocationId:Guid = new Guid() with get,set
        member val Services:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set

    [<AllowNullLiteral>]
    type Agent() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val Company:String = null with get,set
        member val AgentName: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 Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val Country:String = null with get,set
        member val Email:String = null with get,set
        member val EmailSignature: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 InsLicensed:Boolean = new Boolean() with get,set
        member val AgreeToDisclosures:Boolean = new Boolean() with get,set
        member val AgreeToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PaidDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AgentNumber:String = null with get,set
        member val ReferringAgent:String = null with get,set
        member val PlacementAgent:String = null with get,set
        member val CreatedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UserId:Guid = new Guid() with get,set
        member val IsAgent:Boolean = new Boolean() with get,set
        member val Package:String = null with get,set
        member val StoreName:String = null with get,set
        member val Notes:String = null with get,set
        member val Upline1:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Upline2:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Upline3:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Upline4:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MVPID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AVPID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RVPID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AgentLevel:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val IsMVP:Boolean = new Boolean() with get,set
        member val IsRVP:Boolean = new Boolean() with get,set
        member val IsAVP:Boolean = new Boolean() with get,set
        member val IsAdmin:Boolean = new Boolean() with get,set
        member val IsBusinessCardAdmin:Boolean = new Boolean() with get,set
        member val TeamName:String = null with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val CalendarId:Guid = new Guid() with get,set
        member val Rank:String = null with get,set
        member val NBC:Boolean = new Boolean() with get,set
        member val Upline1Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Upline2Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Upline3Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Upline4Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AgentStatus:String = null with get,set
        member val Office:String = null with get,set
        member val DOB:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SSN:String = null with get,set
        member val Fax:String = null with get,set
        member val BusinessEmail:String = null with get,set
        member val ModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ModifiedBy:String = null with get,set
        member val TimeZone:String = null with get,set
        member val LeaderLocked:Boolean = new Boolean() with get,set
        member val LastSubmittedBusinessDate:DateTime = new DateTime() with get,set
        member val GracePeriodDate:DateTime = new DateTime() with get,set
        member val Vested:Boolean = new Boolean() with get,set
        member val DirectPay:DateTime = new DateTime() with get,set
        member val DirectPayApprBy:String = null with get,set
        member val FactFinderBilling:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val FullName:String = null with get,set
        member val ByLastName:String = null with get,set
        member val IsSecurityLicensed:Boolean = new Boolean() with get,set
        member val IsEncompassAdmin:Boolean = new Boolean() with get,set
        member val ApiKey:Guid = new Guid() with get,set
        member val LastSessionId:String = null with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val MfaActive:Boolean = new Boolean() with get,set
        member val RequireMFA:Boolean = new Boolean() with get,set
        member val SMSPhoneNumber:String = null with get,set
        member val VerifiedEmailStatus:Boolean = new Boolean() with get,set
        member val VerifiedCellPhoneStatus:Boolean = new Boolean() with get,set
        member val SchedulerUrl:String = null with get,set
        member val QueueDefaults:QueueDefault = null with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val PasswordUpdated:Boolean = new Boolean() with get,set
        member val RestrictToSingleSession:Boolean = new Boolean() with get,set

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

    [<AllowNullLiteral>]
    type AgentDistrictIdRequest() = 
        member val DistrictId:Int32 = new Int32() with get,set

F# AgentDistrictIdRequest 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/DistrictAgents/{DistrictId} 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
		}
	},
	Agents: 
	[
		{
			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
		}
	]
}