| Required roles: | Agent, Administrator | Requires any of the roles: | Worker, Agent, Administrator |
| GET | /v1/AgentContract/{AgentId} | ||
|---|---|---|---|
| PUT,OPTIONS | /v1/AgentContract |
export class QueueDefault
{
public LocationId: string;
public Services: string[] = [];
public constructor(init?: Partial<QueueDefault>) { (Object as any).assign(this, init); }
}
export class Agent
{
public AgentId: number;
public Company: string;
public AgentName: string;
public FirstName: string;
public LastName: string;
public MiddleInitial: string;
public Address1: string;
public Address2: string;
public City: string;
public State: string;
public Zip: string;
public Country: string;
public Email: string;
public EmailSignature: string;
public HomePhone: string;
public CellPhone: string;
public WorkPhone: string;
public InsLicensed: boolean;
public AgreeToDisclosures: boolean;
public AgreeToDate?: string;
public PaidDate?: string;
public AgentNumber: string;
public ReferringAgent: string;
public PlacementAgent: string;
public CreatedDate?: string;
public UserId: string;
public IsAgent: boolean;
public Package: string;
public StoreName: string;
public Notes: string;
public Upline1?: number;
public Upline2?: number;
public Upline3?: number;
public Upline4?: number;
public MVPID?: number;
public AVPID?: number;
public RVPID?: number;
public AgentLevel?: number;
public IsMVP: boolean;
public IsRVP: boolean;
public IsAVP: boolean;
public IsAdmin: boolean;
public IsBusinessCardAdmin: boolean;
public TeamName: string;
public LocationId: string;
public CalendarId: string;
public Rank: string;
public NBC: boolean;
public Upline1Percent?: number;
public Upline2Percent?: number;
public Upline3Percent?: number;
public Upline4Percent?: number;
public AgentStatus: string;
public Office: string;
public DOB?: string;
public SSN: string;
public Fax: string;
public BusinessEmail: string;
public ModifiedDate?: string;
public ModifiedBy: string;
public TimeZone: string;
public LeaderLocked: boolean;
public LastSubmittedBusinessDate: string;
public GracePeriodDate: string;
public Vested: boolean;
public DirectPay: string;
public DirectPayApprBy: string;
public FactFinderBilling?: number;
public FullName: string;
public ByLastName: string;
public IsSecurityLicensed: boolean;
public IsEncompassAdmin: boolean;
public ApiKey: string;
public LastSessionId: string;
public LastLogin?: string;
public MfaActive: boolean;
public RequireMFA: boolean;
public SMSPhoneNumber: string;
public VerifiedEmailStatus: boolean;
public VerifiedCellPhoneStatus: boolean;
public SchedulerUrl: string;
public QueueDefaults: QueueDefault;
public Roles: string[] = [];
public PasswordUpdated: boolean;
public RestrictToSingleSession: boolean;
public constructor(init?: Partial<Agent>) { (Object as any).assign(this, init); }
}
export class AgentRegistrationTemp
{
public AgentRegistrationTempId: number;
public ApplicationId: string;
public Company: string;
public EIN: string;
public FirstName: string;
public MiddleName: string;
public LastName: string;
public Address1: string;
public Address2: string;
public City: string;
public State: string;
public Zip: string;
public Email: string;
public HomePhone: string;
public CellPhone: string;
public WorkPhone: string;
public AgreeToDisclosures: boolean;
public AgreeToDate: string;
public PaidDate: string;
public AgentNumber: string;
public Upline1Name: string;
public Upline1: number;
public Upline2Name: string;
public Upline2: number;
public RecruitedBy: string;
public CreatedDate: string;
public DOB?: string;
public SSN: string;
public Password: string;
public Upline1Percent: number;
public Upline2Percent: number;
public AgentId: number;
public AccountName: string;
public AccountType: string;
public AccountNumber: string;
public AccountRouting: string;
public w9_1: string;
public w9_2: string;
public w9_3_1: string;
public w9_3_2: string;
public w9_3_3: string;
public w9_3_4: string;
public w9_3_5: string;
public w9_3_6: string;
public w9_3_7: string;
public w9_3_8: string;
public w9_4_1: string;
public w9_4_2: string;
public w9_5: string;
public w9_6: string;
public w9_7: string;
public IsSecurityLicensed: boolean;
public SecurityLicense: string;
public Position: string;
public School: string;
public District: string;
public StoreName: string;
public constructor(init?: Partial<AgentRegistrationTemp>) { (Object as any).assign(this, init); }
}
export class AgentRegistrationAnswer
{
public AgentRegistrationTempId: number;
public QuestionId: number;
public AnswerYN: boolean;
public AnswerText: string;
public DateCreated: string;
public constructor(init?: Partial<AgentRegistrationAnswer>) { (Object as any).assign(this, init); }
}
export class AgentRegistrationQuestionAnswer extends AgentRegistrationAnswer
{
public Details: string;
public QuestionType: string;
public Group: string;
public IndexOrder: number;
public constructor(init?: Partial<AgentRegistrationQuestionAnswer>) { super(init); (Object as any).assign(this, init); }
}
export class AgentStateLicense
{
public AgentRegistrationTempId: number;
public State: string;
public LicenseNum: string;
public constructor(init?: Partial<AgentStateLicense>) { (Object as any).assign(this, init); }
}
export class AgentContractExtended extends Agent
{
public AgentContractId: number;
public AFAgreementReceivedDate: string;
public DirectDepositReceivedDate: string;
public DotNETCompleteDate: string;
public AssociateAppUploadedDate: string;
public LSWContractLinkSentDate: string;
public LSWContractDoneDate: string;
public LSWLifeAgentCode: string;
public LSWAnnuityAgentCode: string;
public LSWWebsiteUserId: string;
public AMLCompletedDate: string;
public StateAnnuityTrainingCompletedDate: string;
public LSWProductTrainingCompletedDate: string;
public EOExpirationDate: string;
public SureLCLinkSentDate: string;
public AEContractDoneDate: string;
public AEAgentCode: string;
public MGANorthAmericanContractSentDate: string;
public MGANorthAmericanAgentCode: string;
public AmericoContractDoneDate: string;
public AmericoAgentCode: string;
public MidlandContractDoneDate: string;
public MidlandAgentCode: string;
public JacksonContractDoneDate: string;
public JacksonAgentCode: string;
public VoyaContractDoneDate: string;
public VoyaAgentCode: string;
public HoraceMannContractDoneDate: string;
public HoraceMannAgentCode: string;
public GreatAmericanContractDoneDate: string;
public GreatAmericanAgentCode: string;
public MutualOfOmahaContractDoneDate: string;
public MutualOfOmahaAgentCode: string;
public AllanzContractDoneDate: string;
public AllanzAgentCode: string;
public FGContractDoneDate: string;
public FGAgentCode: string;
public ResidentLicenseState: string;
public ResidentLicenseNumber: string;
public ResidentLicenseExpirationDate: string;
public ContractingComplete: string;
public PackageMailed: string;
public TrackingNum: string;
public ProtectiveContractDoneDate: string;
public ProtectiveCode: string;
public AtheneContractDoneDate: string;
public AtheneCode: string;
public ForestersContractDoneDate: string;
public ForestersCode: string;
public ACHName: string;
public ACHNumber: string;
public ACHRouting: string;
public ACHAccountType: string;
public w9_1: string;
public w9_2: string;
public w9_3_1: string;
public w9_3_2: string;
public w9_3_3: string;
public w9_3_4: string;
public w9_3_5: string;
public w9_3_6: string;
public w9_3_7: string;
public w9_3_8: string;
public w9_4_1: string;
public w9_4_2: string;
public w9_5: string;
public w9_6: string;
public w9_7: string;
public AgentRegistration: AgentRegistrationTemp;
public AgentRegistrationAnswers: AgentRegistrationQuestionAnswer[] = [];
public AgentStateLicenses: AgentStateLicense[] = [];
public ContactCount: number;
public PayChexId: string;
public AgentLevelLocked?: boolean;
public SecurityLicense: string;
public constructor(init?: Partial<AgentContractExtended>) { super(init); (Object as any).assign(this, init); }
}
export class AgentContractResponse
{
public ResponseStatus: ResponseStatus;
public AgentContract: AgentContractExtended[] = [];
public constructor(init?: Partial<AgentContractResponse>) { (Object as any).assign(this, init); }
}
export class AgentContractRequest
{
public AgentContract: AgentContractExtended[] = [];
public AgentId: number;
public constructor(init?: Partial<AgentContractRequest>) { (Object as any).assign(this, init); }
}
TypeScript AgentContractRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/AgentContract/{AgentId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AgentContract:
[
{
AgentContractId: 0,
AFAgreementReceivedDate: 0001-01-01,
DirectDepositReceivedDate: 0001-01-01,
DotNETCompleteDate: 0001-01-01,
AssociateAppUploadedDate: 0001-01-01,
LSWContractLinkSentDate: 0001-01-01,
LSWContractDoneDate: 0001-01-01,
LSWLifeAgentCode: String,
LSWAnnuityAgentCode: String,
LSWWebsiteUserId: String,
AMLCompletedDate: 0001-01-01,
StateAnnuityTrainingCompletedDate: 0001-01-01,
LSWProductTrainingCompletedDate: 0001-01-01,
EOExpirationDate: 0001-01-01,
SureLCLinkSentDate: 0001-01-01,
AEContractDoneDate: 0001-01-01,
AEAgentCode: String,
MGANorthAmericanContractSentDate: 0001-01-01,
MGANorthAmericanAgentCode: String,
AmericoContractDoneDate: 0001-01-01,
AmericoAgentCode: String,
MidlandContractDoneDate: 0001-01-01,
MidlandAgentCode: String,
JacksonContractDoneDate: 0001-01-01,
JacksonAgentCode: String,
VoyaContractDoneDate: 0001-01-01,
VoyaAgentCode: String,
HoraceMannContractDoneDate: 0001-01-01,
HoraceMannAgentCode: String,
GreatAmericanContractDoneDate: 0001-01-01,
GreatAmericanAgentCode: String,
MutualOfOmahaContractDoneDate: 0001-01-01,
MutualOfOmahaAgentCode: String,
AllanzContractDoneDate: 0001-01-01,
AllanzAgentCode: String,
FGContractDoneDate: 0001-01-01,
FGAgentCode: String,
ResidentLicenseState: String,
ResidentLicenseNumber: String,
ResidentLicenseExpirationDate: 0001-01-01,
ContractingComplete: 0001-01-01,
PackageMailed: 0001-01-01,
TrackingNum: String,
ProtectiveContractDoneDate: 0001-01-01,
ProtectiveCode: String,
AtheneContractDoneDate: 0001-01-01,
AtheneCode: String,
ForestersContractDoneDate: 0001-01-01,
ForestersCode: String,
ACHName: String,
ACHNumber: String,
ACHRouting: String,
ACHAccountType: String,
w9_1: String,
w9_2: String,
w9_3_1: String,
w9_3_2: String,
w9_3_3: String,
w9_3_4: String,
w9_3_5: String,
w9_3_6: String,
w9_3_7: String,
w9_3_8: String,
w9_4_1: String,
w9_4_2: String,
w9_5: String,
w9_6: String,
w9_7: String,
AgentRegistration:
{
AgentRegistrationTempId: 0,
ApplicationId: String,
Company: String,
EIN: String,
FirstName: String,
MiddleName: String,
LastName: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
Email: String,
HomePhone: String,
CellPhone: String,
WorkPhone: String,
AgreeToDisclosures: False,
AgreeToDate: 0001-01-01,
PaidDate: 0001-01-01,
AgentNumber: String,
Upline1Name: String,
Upline1: 0,
Upline2Name: String,
Upline2: 0,
RecruitedBy: String,
CreatedDate: 0001-01-01,
DOB: 0001-01-01,
SSN: String,
Password: String,
Upline1Percent: 0,
Upline2Percent: 0,
AgentId: 0,
AccountName: String,
AccountType: String,
AccountNumber: String,
AccountRouting: String,
w9_1: String,
w9_2: String,
w9_3_1: String,
w9_3_2: String,
w9_3_3: String,
w9_3_4: String,
w9_3_5: String,
w9_3_6: String,
w9_3_7: String,
w9_3_8: String,
w9_4_1: String,
w9_4_2: String,
w9_5: String,
w9_6: String,
w9_7: String,
IsSecurityLicensed: False,
SecurityLicense: String,
Position: String,
School: String,
District: String,
StoreName: String
},
AgentRegistrationAnswers:
[
{
Details: String,
QuestionType: String,
Group: String,
IndexOrder: 0,
AgentRegistrationTempId: 0,
QuestionId: 0,
AnswerYN: False,
AnswerText: String,
DateCreated: 0001-01-01
}
],
AgentStateLicenses:
[
{
AgentRegistrationTempId: 0,
State: String,
LicenseNum: String
}
],
ContactCount: 0,
PayChexId: String,
AgentLevelLocked: False,
SecurityLicense: String,
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
}
],
AgentId: 0
}
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
}
},
AgentContract:
[
{
AgentContractId: 0,
AFAgreementReceivedDate: 0001-01-01,
DirectDepositReceivedDate: 0001-01-01,
DotNETCompleteDate: 0001-01-01,
AssociateAppUploadedDate: 0001-01-01,
LSWContractLinkSentDate: 0001-01-01,
LSWContractDoneDate: 0001-01-01,
LSWLifeAgentCode: String,
LSWAnnuityAgentCode: String,
LSWWebsiteUserId: String,
AMLCompletedDate: 0001-01-01,
StateAnnuityTrainingCompletedDate: 0001-01-01,
LSWProductTrainingCompletedDate: 0001-01-01,
EOExpirationDate: 0001-01-01,
SureLCLinkSentDate: 0001-01-01,
AEContractDoneDate: 0001-01-01,
AEAgentCode: String,
MGANorthAmericanContractSentDate: 0001-01-01,
MGANorthAmericanAgentCode: String,
AmericoContractDoneDate: 0001-01-01,
AmericoAgentCode: String,
MidlandContractDoneDate: 0001-01-01,
MidlandAgentCode: String,
JacksonContractDoneDate: 0001-01-01,
JacksonAgentCode: String,
VoyaContractDoneDate: 0001-01-01,
VoyaAgentCode: String,
HoraceMannContractDoneDate: 0001-01-01,
HoraceMannAgentCode: String,
GreatAmericanContractDoneDate: 0001-01-01,
GreatAmericanAgentCode: String,
MutualOfOmahaContractDoneDate: 0001-01-01,
MutualOfOmahaAgentCode: String,
AllanzContractDoneDate: 0001-01-01,
AllanzAgentCode: String,
FGContractDoneDate: 0001-01-01,
FGAgentCode: String,
ResidentLicenseState: String,
ResidentLicenseNumber: String,
ResidentLicenseExpirationDate: 0001-01-01,
ContractingComplete: 0001-01-01,
PackageMailed: 0001-01-01,
TrackingNum: String,
ProtectiveContractDoneDate: 0001-01-01,
ProtectiveCode: String,
AtheneContractDoneDate: 0001-01-01,
AtheneCode: String,
ForestersContractDoneDate: 0001-01-01,
ForestersCode: String,
ACHName: String,
ACHNumber: String,
ACHRouting: String,
ACHAccountType: String,
w9_1: String,
w9_2: String,
w9_3_1: String,
w9_3_2: String,
w9_3_3: String,
w9_3_4: String,
w9_3_5: String,
w9_3_6: String,
w9_3_7: String,
w9_3_8: String,
w9_4_1: String,
w9_4_2: String,
w9_5: String,
w9_6: String,
w9_7: String,
AgentRegistration:
{
AgentRegistrationTempId: 0,
ApplicationId: String,
Company: String,
EIN: String,
FirstName: String,
MiddleName: String,
LastName: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
Email: String,
HomePhone: String,
CellPhone: String,
WorkPhone: String,
AgreeToDisclosures: False,
AgreeToDate: 0001-01-01,
PaidDate: 0001-01-01,
AgentNumber: String,
Upline1Name: String,
Upline1: 0,
Upline2Name: String,
Upline2: 0,
RecruitedBy: String,
CreatedDate: 0001-01-01,
DOB: 0001-01-01,
SSN: String,
Password: String,
Upline1Percent: 0,
Upline2Percent: 0,
AgentId: 0,
AccountName: String,
AccountType: String,
AccountNumber: String,
AccountRouting: String,
w9_1: String,
w9_2: String,
w9_3_1: String,
w9_3_2: String,
w9_3_3: String,
w9_3_4: String,
w9_3_5: String,
w9_3_6: String,
w9_3_7: String,
w9_3_8: String,
w9_4_1: String,
w9_4_2: String,
w9_5: String,
w9_6: String,
w9_7: String,
IsSecurityLicensed: False,
SecurityLicense: String,
Position: String,
School: String,
District: String,
StoreName: String
},
AgentRegistrationAnswers:
[
{
Details: String,
QuestionType: String,
Group: String,
IndexOrder: 0,
AgentRegistrationTempId: 0,
QuestionId: 0,
AnswerYN: False,
AnswerText: String,
DateCreated: 0001-01-01
}
],
AgentStateLicenses:
[
{
AgentRegistrationTempId: 0,
State: String,
LicenseNum: String
}
],
ContactCount: 0,
PayChexId: String,
AgentLevelLocked: False,
SecurityLicense: String,
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
}
]
}