| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| POST,PUT,OPTIONS | /v1/FactFinder |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class Contact
{
public virtual int ContactId { get; set; }
public virtual int ContactType { get; set; }
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
public virtual string Name { get; set; }
public virtual string Role { get; set; }
public virtual string Title { get; set; }
public virtual string EmailWork { get; set; }
public virtual string EmailPersonal { get; set; }
public virtual string District { get; set; }
public virtual int DistrictID { get; set; }
public virtual string School { get; set; }
public virtual long SchoolID { get; set; }
public virtual string State { get; set; }
public virtual string StateName { get; set; }
public virtual long StateID { get; set; }
public virtual long CountyID { get; set; }
public virtual string County { get; set; }
public virtual string Phone { get; set; }
public virtual string Department { get; set; }
public virtual string Flow { get; set; }
public virtual DateTime LastContact { get; set; }
public virtual bool DoNotContact { get; set; }
public virtual bool Active { get; set; }
public virtual int AgentId { get; set; }
public virtual string PhoneAlt { get; set; }
public virtual int PeraContactId { get; set; }
public virtual string RoomNumber { get; set; }
public virtual int SourceTypeId { get; set; }
public virtual string SourceTypeDesc { get; set; }
public virtual string SourceNote { get; set; }
public virtual int ContactStatusId { get; set; }
public virtual string ContactStatusDesc { get; set; }
public virtual string SSN { get; set; }
public virtual DateTime DateOfBirth { get; set; }
public virtual bool Deleted { get; set; }
public virtual bool IsShared { get; set; }
public virtual string address_line1 { get; set; }
public virtual string address_city { get; set; }
public virtual string address_state { get; set; }
public virtual string address_zip { get; set; }
public virtual string DeletedBy { get; set; }
public virtual DateTime? DeletedDateTimeUtc { get; set; }
public virtual bool HasNBC { get; set; }
public virtual bool HasFactFinderSheet { get; set; }
public virtual string MiddleInitial { get; set; }
public virtual string Tags { get; set; }
public virtual DateTime DateCreated { get; set; }
public virtual string PhoneLabel { get; set; }
public virtual string AltPhoneLabel { get; set; }
public virtual string Carriers { get; set; }
public virtual string ContactImage { get; set; }
public virtual string CompanyAffiliation { get; set; }
public virtual string AdditionalInformation { get; set; }
public virtual bool HasGiftCard { get; set; }
public virtual int ContactCategory { get; set; }
public virtual int WritingAgentId { get; set; }
public virtual string WritingAgentName { get; set; }
public virtual string MaritalStatus { get; set; }
public virtual decimal TotalDebtAmount { get; set; }
public virtual int NumberOfDebtAccounts { get; set; }
public virtual int FactFinderCodeId { get; set; }
public virtual string BusinessName { get; set; }
public virtual string DBA { get; set; }
public virtual Guid ContactGUID { get; set; }
public virtual DateTime ProjectEndDate { get; set; }
public virtual int Rate { get; set; }
public virtual int JobID { get; set; }
public virtual string JobName { get; set; }
public virtual int JobCount { get; set; }
public virtual bool Locked { get; set; }
public virtual int LockedByAgentId { get; set; }
public virtual DateTime LockedTimestamp { get; set; }
public virtual string Initials { get; set; }
public virtual string ContactCategoryName { get; set; }
public virtual bool SMSOptIn { get; set; }
}
public partial class ContactChild
{
public virtual int ContactChildId { get; set; }
public virtual int ContactId { get; set; }
public virtual string Name { get; set; }
public virtual DateTime? DOB { get; set; }
public virtual string Fund { get; set; }
public virtual decimal? Contribution { get; set; }
public virtual decimal? Balance { get; set; }
}
public partial class ContactClientReferral
{
public virtual int ContactClientReferralId { get; set; }
public virtual int ContactId { get; set; }
public virtual string Name { get; set; }
public virtual string Campus { get; set; }
public virtual string Room { get; set; }
public virtual string Phone { get; set; }
}
public partial class ContactExpense
{
public virtual int ContactExpenseId { get; set; }
public virtual int ContactId { get; set; }
public virtual string ExpenseType { get; set; }
public virtual string Description { get; set; }
public virtual decimal? Balance { get; set; }
public virtual decimal? InterestRate { get; set; }
public virtual decimal? MinimumPayment { get; set; }
public virtual decimal? MonthlyPayment { get; set; }
}
public partial class ContactLTAInfo
{
public virtual int ContactLTAInfoId { get; set; }
public virtual int ContactId { get; set; }
public virtual string PlanType { get; set; }
public virtual string Company { get; set; }
public virtual decimal? Contribution { get; set; }
public virtual decimal? Balance { get; set; }
}
public partial class ContactPension
{
public virtual int ContactPensionId { get; set; }
public virtual int ContactId { get; set; }
public virtual string PensionSystem { get; set; }
public virtual DateTime? PensionStartDate { get; set; }
public virtual decimal? ServiceCredit { get; set; }
public virtual DateTime? ServiceCreditAsOfDate { get; set; }
public virtual DateTime? DesiredRetirementDate { get; set; }
public virtual int DesiredRetirementAge { get; set; }
public virtual bool? SpousalBenefitDesired { get; set; }
public virtual decimal? FormulaPercent { get; set; }
public virtual decimal? FormulaAt { get; set; }
public virtual decimal? DefinedBenefitBalance { get; set; }
public virtual decimal? DefinedBenefitSpouseBalance { get; set; }
}
public partial class ContactRetirementIncome
{
public virtual int ContactRetirementIncomeId { get; set; }
public virtual int ContactId { get; set; }
public virtual string AccountOwner { get; set; }
public virtual string AccountType { get; set; }
public virtual string Carrier { get; set; }
public virtual decimal? TotalValue { get; set; }
public virtual decimal? SurrValue { get; set; }
public virtual DateTime? DateOfIssue { get; set; }
public virtual decimal? Fees { get; set; }
public virtual string PolicyNum { get; set; }
public virtual decimal? Contrib { get; set; }
public virtual string EmpNotes { get; set; }
public virtual string TaxCode { get; set; }
public virtual decimal? SurrCharge { get; set; }
public virtual bool? ThirdPrtyPprwrkOK { get; set; }
public virtual bool? AddlFormsReqd { get; set; }
public virtual bool? OriginalFormsReqd { get; set; }
public virtual bool? SignatureGuarReqd { get; set; }
public virtual bool? FaxAccepted { get; set; }
public virtual string FaxNumber { get; set; }
public virtual string MailingAddr { get; set; }
public virtual string MailingCity { get; set; }
public virtual string MailingState { get; set; }
public virtual string MailingZip { get; set; }
public virtual bool? HasOutstandingLoans { get; set; }
}
public partial class ContactSpouse
{
public virtual int ContactSpouseId { get; set; }
public virtual int ContactId { get; set; }
public virtual string Name { get; set; }
public virtual DateTime? DOB { get; set; }
public virtual string Cell { get; set; }
public virtual string Employer { get; set; }
public virtual decimal? Years { get; set; }
public virtual string Position { get; set; }
public virtual string Email { get; set; }
public virtual string PastOccupations { get; set; }
}
public partial class FactFinderRequest
{
public virtual FactFinderSheetExtended FactFinderSheet { get; set; }
public virtual bool DataEntry { get; set; }
}
public partial class FactFinderSheet
{
public virtual int FactFinderSheetId { get; set; }
public virtual int ContactId { get; set; }
public virtual string EmploymentYears { get; set; }
public virtual string PastOccupations { get; set; }
public virtual decimal? ClientGrossMthlyIncome { get; set; }
public virtual decimal? ClientNetMthlyIncome { get; set; }
public virtual decimal? HouseholdGrossMthlyIncome { get; set; }
public virtual decimal? HouseholdNetMthlyIncome { get; set; }
public virtual decimal? EstimatedExpenses { get; set; }
public virtual decimal? DiscretionaryIncome { get; set; }
public virtual decimal? DesiredRetirementIncome { get; set; }
public virtual string RetirementGoals { get; set; }
public virtual decimal? EmergencyFundMthlyContrib { get; set; }
public virtual decimal? EmergencyFundBalance { get; set; }
public virtual bool? EmergencyFundComplete { get; set; }
public virtual string WorkStatus { get; set; }
public virtual decimal? UnusedSickDays { get; set; }
public virtual decimal? UnusedSickHours { get; set; }
public virtual decimal? ContractBaseServPerYrDays { get; set; }
public virtual decimal? ContractBaseServPerYrHours { get; set; }
public virtual decimal? DaysPerWeek { get; set; }
public virtual decimal? HoursPerWeek { get; set; }
public virtual decimal? MonthsPerYear { get; set; }
public virtual int? NumPreTaxChecksPerYr { get; set; }
public virtual decimal? YearsWithOtherDistricts { get; set; }
public virtual bool? PrimaryLifeInsurance { get; set; }
public virtual string PLICarrier { get; set; }
public virtual decimal? PLIFaceAmount { get; set; }
public virtual DateTime? PLIIssueDate { get; set; }
public virtual decimal? PLIPremium { get; set; }
public virtual string PLIType { get; set; }
public virtual string PLITypeOf { get; set; }
public virtual decimal? PLICashValue { get; set; }
public virtual bool? SpouseLifeInsurance { get; set; }
public virtual string SLICarrier { get; set; }
public virtual decimal? SLIFaceAmount { get; set; }
public virtual DateTime? SLIIssueDate { get; set; }
public virtual decimal? SLIPremium { get; set; }
public virtual string SLIType { get; set; }
public virtual string SLITypeOf { get; set; }
public virtual decimal? SLICashValue { get; set; }
public virtual bool? PrimaryLTCInsurance { get; set; }
public virtual decimal? PLTCPremium { get; set; }
public virtual bool? PrimaryDisabilityInsurance { get; set; }
public virtual decimal? PDIPremium { get; set; }
public virtual bool? SpouseLTCInsurance { get; set; }
public virtual decimal? SLTCPremium { get; set; }
public virtual bool? SpouseDisabilityInsurance { get; set; }
public virtual decimal? SDIPremium { get; set; }
public virtual bool? HasRetirementSavings { get; set; }
public virtual bool? HasPriorEmploymentRetirementSavings { get; set; }
public virtual bool? HasDistributionPlan { get; set; }
}
public partial class FactFinderSheetExtended
{
public virtual Contact Contact { get; set; }
public virtual FactFinderSheet FactFinderSheet { get; set; }
public virtual ContactSpouse Spouse { get; set; }
public virtual List<ContactChild> Children { get; set; } = [];
public virtual List<ContactRetirementIncome> IncomeSources { get; set; } = [];
public virtual string AdditionalNotes { get; set; }
public virtual List<ContactExpense> Expenses { get; set; } = [];
public virtual List<ContactClientReferral> Referrals { get; set; } = [];
public virtual List<ContactLTAInfo> LTAInfo { get; set; } = [];
public virtual List<ContactPension> Pensions { get; set; } = [];
}
}
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.
POST /v1/FactFinder HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FactFinderSheet:
{
Contact:
{
ContactId: 0,
ContactType: 0,
FirstName: String,
LastName: String,
Name: String,
Role: String,
Title: String,
EmailWork: String,
EmailPersonal: String,
District: String,
DistrictID: 0,
School: String,
SchoolID: 0,
State: String,
StateName: String,
StateID: 0,
CountyID: 0,
County: String,
Phone: String,
Department: String,
Flow: String,
LastContact: 0001-01-01,
DoNotContact: False,
Active: False,
AgentId: 0,
PhoneAlt: String,
PeraContactId: 0,
RoomNumber: String,
SourceTypeId: 0,
SourceTypeDesc: String,
SourceNote: String,
ContactStatusId: 0,
ContactStatusDesc: String,
SSN: String,
DateOfBirth: 0001-01-01,
Deleted: False,
IsShared: False,
address_line1: String,
address_city: String,
address_state: String,
address_zip: String,
DeletedBy: String,
DeletedDateTimeUtc: 0001-01-01,
HasNBC: False,
HasFactFinderSheet: False,
MiddleInitial: String,
Tags: String,
DateCreated: 0001-01-01,
PhoneLabel: String,
AltPhoneLabel: String,
Carriers: String,
ContactImage: String,
CompanyAffiliation: String,
AdditionalInformation: String,
HasGiftCard: False,
ContactCategory: 0,
WritingAgentId: 0,
WritingAgentName: String,
MaritalStatus: String,
TotalDebtAmount: 0,
NumberOfDebtAccounts: 0,
FactFinderCodeId: 0,
BusinessName: String,
DBA: String,
ContactGUID: 00000000000000000000000000000000,
ProjectEndDate: 0001-01-01,
Rate: 0,
JobID: 0,
JobName: String,
JobCount: 0,
Locked: False,
LockedByAgentId: 0,
LockedTimestamp: 0001-01-01,
Initials: String,
ContactCategoryName: String,
SMSOptIn: False
},
FactFinderSheet:
{
FactFinderSheetId: 0,
ContactId: 0,
EmploymentYears: String,
PastOccupations: String,
ClientGrossMthlyIncome: 0,
ClientNetMthlyIncome: 0,
HouseholdGrossMthlyIncome: 0,
HouseholdNetMthlyIncome: 0,
EstimatedExpenses: 0,
DiscretionaryIncome: 0,
DesiredRetirementIncome: 0,
RetirementGoals: String,
EmergencyFundMthlyContrib: 0,
EmergencyFundBalance: 0,
EmergencyFundComplete: False,
WorkStatus: String,
UnusedSickDays: 0,
UnusedSickHours: 0,
ContractBaseServPerYrDays: 0,
ContractBaseServPerYrHours: 0,
DaysPerWeek: 0,
HoursPerWeek: 0,
MonthsPerYear: 0,
NumPreTaxChecksPerYr: 0,
YearsWithOtherDistricts: 0,
PrimaryLifeInsurance: False,
PLICarrier: String,
PLIFaceAmount: 0,
PLIIssueDate: 0001-01-01,
PLIPremium: 0,
PLIType: String,
PLITypeOf: String,
PLICashValue: 0,
SpouseLifeInsurance: False,
SLICarrier: String,
SLIFaceAmount: 0,
SLIIssueDate: 0001-01-01,
SLIPremium: 0,
SLIType: String,
SLITypeOf: String,
SLICashValue: 0,
PrimaryLTCInsurance: False,
PLTCPremium: 0,
PrimaryDisabilityInsurance: False,
PDIPremium: 0,
SpouseLTCInsurance: False,
SLTCPremium: 0,
SpouseDisabilityInsurance: False,
SDIPremium: 0,
HasRetirementSavings: False,
HasPriorEmploymentRetirementSavings: False,
HasDistributionPlan: False
},
Spouse:
{
ContactSpouseId: 0,
ContactId: 0,
Name: String,
DOB: 0001-01-01,
Cell: String,
Employer: String,
Years: 0,
Position: String,
Email: String,
PastOccupations: String
},
Children:
[
{
ContactChildId: 0,
ContactId: 0,
Name: String,
DOB: 0001-01-01,
Fund: String,
Contribution: 0,
Balance: 0
}
],
IncomeSources:
[
{
ContactRetirementIncomeId: 0,
ContactId: 0,
AccountOwner: String,
AccountType: String,
Carrier: String,
TotalValue: 0,
SurrValue: 0,
DateOfIssue: 0001-01-01,
Fees: 0,
PolicyNum: String,
Contrib: 0,
EmpNotes: String,
TaxCode: String,
SurrCharge: 0,
ThirdPrtyPprwrkOK: False,
AddlFormsReqd: False,
OriginalFormsReqd: False,
SignatureGuarReqd: False,
FaxAccepted: False,
FaxNumber: String,
MailingAddr: String,
MailingCity: String,
MailingState: String,
MailingZip: String,
HasOutstandingLoans: False
}
],
AdditionalNotes: String,
Expenses:
[
{
ContactExpenseId: 0,
ContactId: 0,
ExpenseType: String,
Description: String,
Balance: 0,
InterestRate: 0,
MinimumPayment: 0,
MonthlyPayment: 0
}
],
Referrals:
[
{
ContactClientReferralId: 0,
ContactId: 0,
Name: String,
Campus: String,
Room: String,
Phone: String
}
],
LTAInfo:
[
{
ContactLTAInfoId: 0,
ContactId: 0,
PlanType: String,
Company: String,
Contribution: 0,
Balance: 0
}
],
Pensions:
[
{
ContactPensionId: 0,
ContactId: 0,
PensionSystem: String,
PensionStartDate: 0001-01-01,
ServiceCredit: 0,
ServiceCreditAsOfDate: 0001-01-01,
DesiredRetirementDate: 0001-01-01,
DesiredRetirementAge: 0,
SpousalBenefitDesired: False,
FormulaPercent: 0,
FormulaAt: 0,
DefinedBenefitBalance: 0,
DefinedBenefitSpouseBalance: 0
}
]
},
DataEntry: False
}