Trendsic Platform Service

<back to all web services

AgentRecruitRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentRecruit
"use strict";
export class AgentRecruit {
    /** @param {{Rank?:string,AgentLevel?:string,UL1FirstName?:string,UL1MiddleName?:string,UL1LastName?:string,UL2FirstName?:string,UL2MiddleName?:string,UL2LastName?:string,UL3FirstName?:string,UL3MiddleName?:string,UL3LastName?:string,UL4FirstName?:string,UL4MiddleName?:string,UL4LastName?:string,Company?:string,FirstName?:string,LastName?:string,MiddleInitial?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Country?:string,Email?:string,HomePhone?:string,CellPhone?:string,WorkPhone?:string,AgentNumber?:string,PlacementAgentName?:string,PlacementAgent?:string,CreatedDate?:string,Level?:string,LastLoginDate?:string,Package?:string,AppCount?:number,Cashflow?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Rank;
    /** @type {string} */
    AgentLevel;
    /** @type {string} */
    UL1FirstName;
    /** @type {string} */
    UL1MiddleName;
    /** @type {string} */
    UL1LastName;
    /** @type {string} */
    UL2FirstName;
    /** @type {string} */
    UL2MiddleName;
    /** @type {string} */
    UL2LastName;
    /** @type {string} */
    UL3FirstName;
    /** @type {string} */
    UL3MiddleName;
    /** @type {string} */
    UL3LastName;
    /** @type {string} */
    UL4FirstName;
    /** @type {string} */
    UL4MiddleName;
    /** @type {string} */
    UL4LastName;
    /** @type {string} */
    Company;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    MiddleInitial;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Country;
    /** @type {string} */
    Email;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    WorkPhone;
    /** @type {string} */
    AgentNumber;
    /** @type {string} */
    PlacementAgentName;
    /** @type {string} */
    PlacementAgent;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    Level;
    /** @type {string} */
    LastLoginDate;
    /** @type {string} */
    Package;
    /** @type {number} */
    AppCount;
    /** @type {number} */
    Cashflow;
}
export class AgentRecruitResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentRecruit?:AgentRecruit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentRecruit[]} */
    AgentRecruit = [];
}
export class AgentRecruitRequest {
    /** @param {{AgentRecruit?:AgentRecruit[],StartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AgentRecruit[]} */
    AgentRecruit = [];
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
}

JavaScript AgentRecruitRequest 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/AgentRecruit 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
		}
	},
	AgentRecruit: 
	[
		{
			Rank: String,
			AgentLevel: String,
			UL1FirstName: String,
			UL1MiddleName: String,
			UL1LastName: String,
			UL2FirstName: String,
			UL2MiddleName: String,
			UL2LastName: String,
			UL3FirstName: String,
			UL3MiddleName: String,
			UL3LastName: String,
			UL4FirstName: String,
			UL4MiddleName: String,
			UL4LastName: String,
			Company: String,
			FirstName: String,
			LastName: String,
			MiddleInitial: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Country: String,
			Email: String,
			HomePhone: String,
			CellPhone: String,
			WorkPhone: String,
			AgentNumber: String,
			PlacementAgentName: String,
			PlacementAgent: String,
			CreatedDate: 0001-01-01,
			Level: 0,
			LastLoginDate: 0001-01-01,
			Package: String,
			AppCount: 0,
			Cashflow: 0
		}
	]
}