Trendsic Platform Service

<back to all web services

AgentCrmRecruitRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentCrmRecruit/{AgentId}
"use strict";
export class AgentCrmRecruit {
    /** @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,firstMVP?:string,lastMVP?:string,firstAVP?:string,lastAVP?:string,firstRVP?:string,lastRVP?:string,ResidentLicenseState?:string,ResidentLicenseExpirationDate?:string,AgentId?:number,AgentStatus?:string,Office?:string,Upline1Percent?:number,Upline2Percent?:number,Upline3Percent?:number,Upline4Percent?:number,FirstName?:string,LastName?:string,MiddleInitial?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Email?:string,BusinessEmail?:string,HomePhone?:string,CellPhone?:string,WorkPhone?:string,Fax?:string,AgentNumber?:string,PlacementAgent?:string,CreatedDate?:string,Level?:string,Package?:string,AppCount?:number,Cashflow?:number,TimeZone?:string,Tags?:string,Longitude?:number,Latitude?: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} */
    firstMVP;
    /** @type {string} */
    lastMVP;
    /** @type {string} */
    firstAVP;
    /** @type {string} */
    lastAVP;
    /** @type {string} */
    firstRVP;
    /** @type {string} */
    lastRVP;
    /** @type {string} */
    ResidentLicenseState;
    /** @type {string} */
    ResidentLicenseExpirationDate;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentStatus;
    /** @type {string} */
    Office;
    /** @type {number} */
    Upline1Percent;
    /** @type {number} */
    Upline2Percent;
    /** @type {number} */
    Upline3Percent;
    /** @type {number} */
    Upline4Percent;
    /** @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} */
    Email;
    /** @type {string} */
    BusinessEmail;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    WorkPhone;
    /** @type {string} */
    Fax;
    /** @type {string} */
    AgentNumber;
    /** @type {string} */
    PlacementAgent;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    Level;
    /** @type {string} */
    Package;
    /** @type {number} */
    AppCount;
    /** @type {number} */
    Cashflow;
    /** @type {string} */
    TimeZone;
    /** @type {string} */
    Tags;
    /** @type {number} */
    Longitude;
    /** @type {number} */
    Latitude;
}
export class AgentCrmRecruitResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentCrmRecruit?:AgentCrmRecruit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentCrmRecruit[]} */
    AgentCrmRecruit = [];
}
export class AgentCrmRecruitRequest {
    /** @param {{AgentID?:number,AgentCrmRecruit?:AgentCrmRecruit[],StartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentID;
    /** @type {AgentCrmRecruit[]} */
    AgentCrmRecruit = [];
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
}

JavaScript AgentCrmRecruitRequest 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/AgentCrmRecruit/{AgentId} 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
		}
	},
	AgentCrmRecruit: 
	[
		{
			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,
			firstMVP: String,
			lastMVP: String,
			firstAVP: String,
			lastAVP: String,
			firstRVP: String,
			lastRVP: String,
			ResidentLicenseState: String,
			ResidentLicenseExpirationDate: String,
			AgentId: 0,
			AgentStatus: String,
			Office: String,
			Upline1Percent: 0,
			Upline2Percent: 0,
			Upline3Percent: 0,
			Upline4Percent: 0,
			FirstName: String,
			LastName: String,
			MiddleInitial: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Email: String,
			BusinessEmail: String,
			HomePhone: String,
			CellPhone: String,
			WorkPhone: String,
			Fax: String,
			AgentNumber: String,
			PlacementAgent: String,
			CreatedDate: 0001-01-01,
			Level: String,
			Package: String,
			AppCount: 0,
			Cashflow: 0,
			TimeZone: String,
			Tags: String,
			Longitude: 0,
			Latitude: 0
		}
	]
}