Trendsic Platform Service

<back to all web services

SmartsheetsTransferRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Smartsheets/TransferLines
"use strict";
export class QueueDefault {
    /** @param {{LocationId?:string,Services?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string[]} */
    Services = [];
}
export class Agent {
    /** @param {{AgentId?:number,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?:boolean,AgreeToDisclosures?:boolean,AgreeToDate?:string,PaidDate?:string,AgentNumber?:string,ReferringAgent?:string,PlacementAgent?:string,CreatedDate?:string,UserId?:string,IsAgent?:boolean,Package?:string,StoreName?:string,Notes?:string,Upline1?:number,Upline2?:number,Upline3?:number,Upline4?:number,MVPID?:number,AVPID?:number,RVPID?:number,AgentLevel?:number,IsMVP?:boolean,IsRVP?:boolean,IsAVP?:boolean,IsAdmin?:boolean,IsBusinessCardAdmin?:boolean,TeamName?:string,LocationId?:string,CalendarId?:string,Rank?:string,NBC?:boolean,Upline1Percent?:number,Upline2Percent?:number,Upline3Percent?:number,Upline4Percent?:number,AgentStatus?:string,Office?:string,DOB?:string,SSN?:string,Fax?:string,BusinessEmail?:string,ModifiedDate?:string,ModifiedBy?:string,TimeZone?:string,LeaderLocked?:boolean,LastSubmittedBusinessDate?:string,GracePeriodDate?:string,Vested?:boolean,DirectPay?:string,DirectPayApprBy?:string,FactFinderBilling?:number,FullName?:string,ByLastName?:string,IsSecurityLicensed?:boolean,IsEncompassAdmin?:boolean,ApiKey?:string,LastSessionId?:string,LastLogin?:string,MfaActive?:boolean,RequireMFA?:boolean,SMSPhoneNumber?:string,VerifiedEmailStatus?:boolean,VerifiedCellPhoneStatus?:boolean,SchedulerUrl?:string,QueueDefaults?:QueueDefault,Roles?:string[],PasswordUpdated?:boolean,RestrictToSingleSession?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    Company;
    /** @type {string} */
    AgentName;
    /** @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} */
    EmailSignature;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    WorkPhone;
    /** @type {boolean} */
    InsLicensed;
    /** @type {boolean} */
    AgreeToDisclosures;
    /** @type {?string} */
    AgreeToDate;
    /** @type {?string} */
    PaidDate;
    /** @type {string} */
    AgentNumber;
    /** @type {string} */
    ReferringAgent;
    /** @type {string} */
    PlacementAgent;
    /** @type {?string} */
    CreatedDate;
    /** @type {string} */
    UserId;
    /** @type {boolean} */
    IsAgent;
    /** @type {string} */
    Package;
    /** @type {string} */
    StoreName;
    /** @type {string} */
    Notes;
    /** @type {?number} */
    Upline1;
    /** @type {?number} */
    Upline2;
    /** @type {?number} */
    Upline3;
    /** @type {?number} */
    Upline4;
    /** @type {?number} */
    MVPID;
    /** @type {?number} */
    AVPID;
    /** @type {?number} */
    RVPID;
    /** @type {?number} */
    AgentLevel;
    /** @type {boolean} */
    IsMVP;
    /** @type {boolean} */
    IsRVP;
    /** @type {boolean} */
    IsAVP;
    /** @type {boolean} */
    IsAdmin;
    /** @type {boolean} */
    IsBusinessCardAdmin;
    /** @type {string} */
    TeamName;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    CalendarId;
    /** @type {string} */
    Rank;
    /** @type {boolean} */
    NBC;
    /** @type {?number} */
    Upline1Percent;
    /** @type {?number} */
    Upline2Percent;
    /** @type {?number} */
    Upline3Percent;
    /** @type {?number} */
    Upline4Percent;
    /** @type {string} */
    AgentStatus;
    /** @type {string} */
    Office;
    /** @type {?string} */
    DOB;
    /** @type {string} */
    SSN;
    /** @type {string} */
    Fax;
    /** @type {string} */
    BusinessEmail;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    ModifiedBy;
    /** @type {string} */
    TimeZone;
    /** @type {boolean} */
    LeaderLocked;
    /** @type {string} */
    LastSubmittedBusinessDate;
    /** @type {string} */
    GracePeriodDate;
    /** @type {boolean} */
    Vested;
    /** @type {string} */
    DirectPay;
    /** @type {string} */
    DirectPayApprBy;
    /** @type {?number} */
    FactFinderBilling;
    /** @type {string} */
    FullName;
    /** @type {string} */
    ByLastName;
    /** @type {boolean} */
    IsSecurityLicensed;
    /** @type {boolean} */
    IsEncompassAdmin;
    /** @type {string} */
    ApiKey;
    /** @type {string} */
    LastSessionId;
    /** @type {?string} */
    LastLogin;
    /** @type {boolean} */
    MfaActive;
    /** @type {boolean} */
    RequireMFA;
    /** @type {string} */
    SMSPhoneNumber;
    /** @type {boolean} */
    VerifiedEmailStatus;
    /** @type {boolean} */
    VerifiedCellPhoneStatus;
    /** @type {string} */
    SchedulerUrl;
    /** @type {QueueDefault} */
    QueueDefaults;
    /** @type {string[]} */
    Roles = [];
    /** @type {boolean} */
    PasswordUpdated;
    /** @type {boolean} */
    RestrictToSingleSession;
}
export class SmartsheetRecord {
    /** @param {{ID?:number,TableName?:string,PolicyAssociateId?:string,AgentName?:string,ClientName?:string,PolicyNumber?:string,TransactionId?:string,type?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    TableName;
    /** @type {string} */
    PolicyAssociateId;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    ClientName;
    /** @type {string} */
    PolicyNumber;
    /** @type {string} */
    TransactionId;
    /** @type {string} */
    type;
}
export class SmartsheetsTransferRequest {
    /** @param {{agent?:Agent,lines?:SmartsheetRecord[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Agent} */
    agent;
    /** @type {SmartsheetRecord[]} */
    lines = [];
}

JavaScript SmartsheetsTransferRequest 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/Smartsheets/TransferLines 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
	},
	lines: 
	[
		{
			ID: 0,
			TableName: String,
			PolicyAssociateId: 00000000000000000000000000000000,
			AgentName: String,
			ClientName: String,
			PolicyNumber: String,
			TransactionId: String,
			type: String
		}
	]
}