Trendsic Platform Service

<back to all web services

FactFinderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
POST,PUT,OPTIONS/v1/FactFinder
FactFinderRequest Parameters:
NameParameterData TypeRequiredDescription
FactFinderSheetbodyFactFinderSheetExtendedNo
DataEntrybodyboolNo
FactFinderSheetExtended Parameters:
NameParameterData TypeRequiredDescription
ContactformContactNo
FactFinderSheetformFactFinderSheetNo
SpouseformContactSpouseNo
ChildrenformList<ContactChild>No
IncomeSourcesformList<ContactRetirementIncome>No
AdditionalNotesformstringNo
ExpensesformList<ContactExpense>No
ReferralsformList<ContactClientReferral>No
LTAInfoformList<ContactLTAInfo>No
PensionsformList<ContactPension>No
Contact Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
ContactTypeformintNo
FirstNameformstringNo
LastNameformstringNo
NameformstringNo
RoleformstringNo
TitleformstringNo
EmailWorkformstringNo
EmailPersonalformstringNo
DistrictformstringNo
DistrictIDformintNo
SchoolformstringNo
SchoolIDformlongNo
StateformstringNo
StateNameformstringNo
StateIDformlongNo
CountyIDformlongNo
CountyformstringNo
PhoneformstringNo
DepartmentformstringNo
FlowformstringNo
LastContactformDateTimeNo
DoNotContactformboolNo
ActiveformboolNo
AgentIdformintNo
PhoneAltformstringNo
PeraContactIdformintNo
RoomNumberformstringNo
SourceTypeIdformintNo
SourceTypeDescformstringNo
SourceNoteformstringNo
ContactStatusIdformintNo
ContactStatusDescformstringNo
SSNformstringNo
DateOfBirthformDateTimeNo
DeletedformboolNo
IsSharedformboolNo
address_line1formstringNo
address_cityformstringNo
address_stateformstringNo
address_zipformstringNo
DeletedByformstringNo
DeletedDateTimeUtcformDateTime?No
HasNBCformboolNo
HasFactFinderSheetformboolNo
MiddleInitialformstringNo
TagsformstringNo
DateCreatedformDateTimeNo
PhoneLabelformstringNo
AltPhoneLabelformstringNo
CarriersformstringNo
ContactImageformstringNo
CompanyAffiliationformstringNo
AdditionalInformationformstringNo
HasGiftCardformboolNo
ContactCategoryformintNo
WritingAgentIdformintNo
WritingAgentNameformstringNo
MaritalStatusformstringNo
TotalDebtAmountformdecimalNo
NumberOfDebtAccountsformintNo
FactFinderCodeIdformintNo
BusinessNameformstringNo
DBAformstringNo
ContactGUIDformGuidNo
ProjectEndDateformDateTimeNo
RateformintNo
JobIDformintNo
JobNameformstringNo
JobCountformintNo
LockedformboolNo
LockedByAgentIdformintNo
LockedTimestampformDateTimeNo
InitialsformstringNo
ContactCategoryNameformstringNo
SMSOptInformboolNo
FactFinderSheet Parameters:
NameParameterData TypeRequiredDescription
FactFinderSheetIdformintNo
ContactIdformintNo
EmploymentYearsformstringNo
PastOccupationsformstringNo
ClientGrossMthlyIncomeformdecimal?No
ClientNetMthlyIncomeformdecimal?No
HouseholdGrossMthlyIncomeformdecimal?No
HouseholdNetMthlyIncomeformdecimal?No
EstimatedExpensesformdecimal?No
DiscretionaryIncomeformdecimal?No
DesiredRetirementIncomeformdecimal?No
RetirementGoalsformstringNo
EmergencyFundMthlyContribformdecimal?No
EmergencyFundBalanceformdecimal?No
EmergencyFundCompleteformbool?No
WorkStatusformstringNo
UnusedSickDaysformdecimal?No
UnusedSickHoursformdecimal?No
ContractBaseServPerYrDaysformdecimal?No
ContractBaseServPerYrHoursformdecimal?No
DaysPerWeekformdecimal?No
HoursPerWeekformdecimal?No
MonthsPerYearformdecimal?No
NumPreTaxChecksPerYrformint?No
YearsWithOtherDistrictsformdecimal?No
PrimaryLifeInsuranceformbool?No
PLICarrierformstringNo
PLIFaceAmountformdecimal?No
PLIIssueDateformDateTime?No
PLIPremiumformdecimal?No
PLITypeformstringNo
PLITypeOfformstringNo
PLICashValueformdecimal?No
SpouseLifeInsuranceformbool?No
SLICarrierformstringNo
SLIFaceAmountformdecimal?No
SLIIssueDateformDateTime?No
SLIPremiumformdecimal?No
SLITypeformstringNo
SLITypeOfformstringNo
SLICashValueformdecimal?No
PrimaryLTCInsuranceformbool?No
PLTCPremiumformdecimal?No
PrimaryDisabilityInsuranceformbool?No
PDIPremiumformdecimal?No
SpouseLTCInsuranceformbool?No
SLTCPremiumformdecimal?No
SpouseDisabilityInsuranceformbool?No
SDIPremiumformdecimal?No
HasRetirementSavingsformbool?No
HasPriorEmploymentRetirementSavingsformbool?No
HasDistributionPlanformbool?No
ContactSpouse Parameters:
NameParameterData TypeRequiredDescription
ContactSpouseIdformintNo
ContactIdformintNo
NameformstringNo
DOBformDateTime?No
CellformstringNo
EmployerformstringNo
Yearsformdecimal?No
PositionformstringNo
EmailformstringNo
PastOccupationsformstringNo
ContactChild Parameters:
NameParameterData TypeRequiredDescription
ContactChildIdformintNo
ContactIdformintNo
NameformstringNo
DOBformDateTime?No
FundformstringNo
Contributionformdecimal?No
Balanceformdecimal?No
ContactRetirementIncome Parameters:
NameParameterData TypeRequiredDescription
ContactRetirementIncomeIdformintNo
ContactIdformintNo
AccountOwnerformstringNo
AccountTypeformstringNo
CarrierformstringNo
TotalValueformdecimal?No
SurrValueformdecimal?No
DateOfIssueformDateTime?No
Feesformdecimal?No
PolicyNumformstringNo
Contribformdecimal?No
EmpNotesformstringNo
TaxCodeformstringNo
SurrChargeformdecimal?No
ThirdPrtyPprwrkOKformbool?No
AddlFormsReqdformbool?No
OriginalFormsReqdformbool?No
SignatureGuarReqdformbool?No
FaxAcceptedformbool?No
FaxNumberformstringNo
MailingAddrformstringNo
MailingCityformstringNo
MailingStateformstringNo
MailingZipformstringNo
HasOutstandingLoansformbool?No
ContactExpense Parameters:
NameParameterData TypeRequiredDescription
ContactExpenseIdformintNo
ContactIdformintNo
ExpenseTypeformstringNo
DescriptionformstringNo
Balanceformdecimal?No
InterestRateformdecimal?No
MinimumPaymentformdecimal?No
MonthlyPaymentformdecimal?No
ContactClientReferral Parameters:
NameParameterData TypeRequiredDescription
ContactClientReferralIdformintNo
ContactIdformintNo
NameformstringNo
CampusformstringNo
RoomformstringNo
PhoneformstringNo
ContactLTAInfo Parameters:
NameParameterData TypeRequiredDescription
ContactLTAInfoIdformintNo
ContactIdformintNo
PlanTypeformstringNo
CompanyformstringNo
Contributionformdecimal?No
Balanceformdecimal?No
ContactPension Parameters:
NameParameterData TypeRequiredDescription
ContactPensionIdformintNo
ContactIdformintNo
PensionSystemformstringNo
PensionStartDateformDateTime?No
ServiceCreditformdecimal?No
ServiceCreditAsOfDateformDateTime?No
DesiredRetirementDateformDateTime?No
DesiredRetirementAgeformintNo
SpousalBenefitDesiredformbool?No
FormulaPercentformdecimal?No
FormulaAtformdecimal?No
DefinedBenefitBalanceformdecimal?No
DefinedBenefitSpouseBalanceformdecimal?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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-01T00:00:00.0000000","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-01T00:00:00.0000000","Deleted":false,"IsShared":false,"address_line1":"String","address_city":"String","address_state":"String","address_zip":"String","DeletedBy":"String","DeletedDateTimeUtc":"0001-01-01T00:00:00.0000000","HasNBC":false,"HasFactFinderSheet":false,"MiddleInitial":"String","Tags":"String","DateCreated":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","Rate":0,"JobID":0,"JobName":"String","JobCount":0,"Locked":false,"LockedByAgentId":0,"LockedTimestamp":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","PLIPremium":0,"PLIType":"String","PLITypeOf":"String","PLICashValue":0,"SpouseLifeInsurance":false,"SLICarrier":"String","SLIFaceAmount":0,"SLIIssueDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","Cell":"String","Employer":"String","Years":0,"Position":"String","Email":"String","PastOccupations":"String"},"Children":[{"ContactChildId":0,"ContactId":0,"Name":"String","DOB":"0001-01-01T00:00:00.0000000","Fund":"String","Contribution":0,"Balance":0}],"IncomeSources":[{"ContactRetirementIncomeId":0,"ContactId":0,"AccountOwner":"String","AccountType":"String","Carrier":"String","TotalValue":0,"SurrValue":0,"DateOfIssue":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ServiceCredit":0,"ServiceCreditAsOfDate":"0001-01-01T00:00:00.0000000","DesiredRetirementDate":"0001-01-01T00:00:00.0000000","DesiredRetirementAge":0,"SpousalBenefitDesired":false,"FormulaPercent":0,"FormulaAt":0,"DefinedBenefitBalance":0,"DefinedBenefitSpouseBalance":0}]},"DataEntry":false}