| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| POST,PUT,OPTIONS | /v1/FactFinder |
|---|
import Foundation
import ServiceStack
public class FactFinderRequest : Codable
{
public var factFinderSheet:FactFinderSheetExtended
public var dataEntry:Bool
required public init(){}
}
public class FactFinderSheetExtended : Codable
{
public var contact:Contact
public var factFinderSheet:FactFinderSheet
public var spouse:ContactSpouse
public var children:[ContactChild] = []
public var incomeSources:[ContactRetirementIncome] = []
public var additionalNotes:String
public var expenses:[ContactExpense] = []
public var referrals:[ContactClientReferral] = []
public var ltaInfo:[ContactLTAInfo] = []
public var pensions:[ContactPension] = []
required public init(){}
}
public class Contact : Codable
{
public var contactId:Int
public var contactType:Int
public var firstName:String
public var lastName:String
public var name:String
public var role:String
public var title:String
public var emailWork:String
public var emailPersonal:String
public var district:String
public var districtID:Int
public var school:String
public var schoolID:Int
public var state:String
public var stateName:String
public var stateID:Int
public var countyID:Int
public var county:String
public var phone:String
public var department:String
public var flow:String
public var lastContact:Date
public var doNotContact:Bool
public var active:Bool
public var agentId:Int
public var phoneAlt:String
public var peraContactId:Int
public var roomNumber:String
public var sourceTypeId:Int
public var sourceTypeDesc:String
public var sourceNote:String
public var contactStatusId:Int
public var contactStatusDesc:String
public var ssn:String
public var dateOfBirth:Date
public var deleted:Bool
public var isShared:Bool
public var address_line1:String
public var address_city:String
public var address_state:String
public var address_zip:String
public var deletedBy:String
public var deletedDateTimeUtc:Date?
public var hasNBC:Bool
public var hasFactFinderSheet:Bool
public var middleInitial:String
public var tags:String
public var dateCreated:Date
public var phoneLabel:String
public var altPhoneLabel:String
public var carriers:String
public var contactImage:String
public var companyAffiliation:String
public var additionalInformation:String
public var hasGiftCard:Bool
public var contactCategory:Int
public var writingAgentId:Int
public var writingAgentName:String
public var maritalStatus:String
public var totalDebtAmount:Double
public var numberOfDebtAccounts:Int
public var factFinderCodeId:Int
public var businessName:String
public var dba:String
public var contactGUID:String
public var projectEndDate:Date
public var rate:Int
public var jobID:Int
public var jobName:String
public var jobCount:Int
public var locked:Bool
public var lockedByAgentId:Int
public var lockedTimestamp:Date
public var initials:String
public var contactCategoryName:String
public var smsOptIn:Bool
required public init(){}
}
public class FactFinderSheet : Codable
{
public var factFinderSheetId:Int
public var contactId:Int
public var employmentYears:String
public var pastOccupations:String
public var clientGrossMthlyIncome:Double?
public var clientNetMthlyIncome:Double?
public var householdGrossMthlyIncome:Double?
public var householdNetMthlyIncome:Double?
public var estimatedExpenses:Double?
public var discretionaryIncome:Double?
public var desiredRetirementIncome:Double?
public var retirementGoals:String
public var emergencyFundMthlyContrib:Double?
public var emergencyFundBalance:Double?
public var emergencyFundComplete:Bool?
public var workStatus:String
public var unusedSickDays:Double?
public var unusedSickHours:Double?
public var contractBaseServPerYrDays:Double?
public var contractBaseServPerYrHours:Double?
public var daysPerWeek:Double?
public var hoursPerWeek:Double?
public var monthsPerYear:Double?
public var numPreTaxChecksPerYr:Int?
public var yearsWithOtherDistricts:Double?
public var primaryLifeInsurance:Bool?
public var pliCarrier:String
public var pliFaceAmount:Double?
public var pliIssueDate:Date?
public var pliPremium:Double?
public var pliType:String
public var pliTypeOf:String
public var pliCashValue:Double?
public var spouseLifeInsurance:Bool?
public var sliCarrier:String
public var sliFaceAmount:Double?
public var sliIssueDate:Date?
public var sliPremium:Double?
public var sliType:String
public var sliTypeOf:String
public var sliCashValue:Double?
public var primaryLTCInsurance:Bool?
public var pltcPremium:Double?
public var primaryDisabilityInsurance:Bool?
public var pdiPremium:Double?
public var spouseLTCInsurance:Bool?
public var sltcPremium:Double?
public var spouseDisabilityInsurance:Bool?
public var sdiPremium:Double?
public var hasRetirementSavings:Bool?
public var hasPriorEmploymentRetirementSavings:Bool?
public var hasDistributionPlan:Bool?
required public init(){}
}
public class ContactSpouse : Codable
{
public var contactSpouseId:Int
public var contactId:Int
public var name:String
public var dob:Date?
public var cell:String
public var employer:String
public var years:Double?
public var position:String
public var email:String
public var pastOccupations:String
required public init(){}
}
public class ContactChild : Codable
{
public var contactChildId:Int
public var contactId:Int
public var name:String
public var dob:Date?
public var fund:String
public var contribution:Double?
public var balance:Double?
required public init(){}
}
public class ContactRetirementIncome : Codable
{
public var contactRetirementIncomeId:Int
public var contactId:Int
public var accountOwner:String
public var accountType:String
public var carrier:String
public var totalValue:Double?
public var surrValue:Double?
public var dateOfIssue:Date?
public var fees:Double?
public var policyNum:String
public var contrib:Double?
public var empNotes:String
public var taxCode:String
public var surrCharge:Double?
public var thirdPrtyPprwrkOK:Bool?
public var addlFormsReqd:Bool?
public var originalFormsReqd:Bool?
public var signatureGuarReqd:Bool?
public var faxAccepted:Bool?
public var faxNumber:String
public var mailingAddr:String
public var mailingCity:String
public var mailingState:String
public var mailingZip:String
public var hasOutstandingLoans:Bool?
required public init(){}
}
public class ContactExpense : Codable
{
public var contactExpenseId:Int
public var contactId:Int
public var expenseType:String
public var Description:String
public var balance:Double?
public var interestRate:Double?
public var minimumPayment:Double?
public var monthlyPayment:Double?
required public init(){}
}
public class ContactClientReferral : Codable
{
public var contactClientReferralId:Int
public var contactId:Int
public var name:String
public var campus:String
public var room:String
public var phone:String
required public init(){}
}
public class ContactLTAInfo : Codable
{
public var contactLTAInfoId:Int
public var contactId:Int
public var planType:String
public var company:String
public var contribution:Double?
public var balance:Double?
required public init(){}
}
public class ContactPension : Codable
{
public var contactPensionId:Int
public var contactId:Int
public var pensionSystem:String
public var pensionStartDate:Date?
public var serviceCredit:Double?
public var serviceCreditAsOfDate:Date?
public var desiredRetirementDate:Date?
public var desiredRetirementAge:Int
public var spousalBenefitDesired:Bool?
public var formulaPercent:Double?
public var formulaAt:Double?
public var definedBenefitBalance:Double?
public var definedBenefitSpouseBalance:Double?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<FactFinderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<DataEntry>false</DataEntry>
<FactFinderSheet>
<AdditionalNotes>String</AdditionalNotes>
<Children>
<ContactChild>
<Balance>0</Balance>
<ContactChildId>0</ContactChildId>
<ContactId>0</ContactId>
<Contribution>0</Contribution>
<DOB>0001-01-01T00:00:00</DOB>
<Fund>String</Fund>
<Name>String</Name>
</ContactChild>
</Children>
<Contact>
<Active>false</Active>
<AdditionalInformation>String</AdditionalInformation>
<AgentId>0</AgentId>
<AltPhoneLabel>String</AltPhoneLabel>
<BusinessName>String</BusinessName>
<Carriers>String</Carriers>
<CompanyAffiliation>String</CompanyAffiliation>
<ContactCategory>0</ContactCategory>
<ContactCategoryName>String</ContactCategoryName>
<ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
<ContactId>0</ContactId>
<ContactImage>String</ContactImage>
<ContactStatusDesc>String</ContactStatusDesc>
<ContactStatusId>0</ContactStatusId>
<ContactType>0</ContactType>
<County>String</County>
<CountyID>0</CountyID>
<DBA>String</DBA>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Deleted>false</Deleted>
<DeletedBy>String</DeletedBy>
<DeletedDateTimeUtc>0001-01-01T00:00:00</DeletedDateTimeUtc>
<Department>String</Department>
<District>String</District>
<DistrictID>0</DistrictID>
<DoNotContact>false</DoNotContact>
<EmailPersonal>String</EmailPersonal>
<EmailWork>String</EmailWork>
<FactFinderCodeId>0</FactFinderCodeId>
<FirstName>String</FirstName>
<Flow>String</Flow>
<HasFactFinderSheet>false</HasFactFinderSheet>
<HasGiftCard>false</HasGiftCard>
<HasNBC>false</HasNBC>
<Initials>String</Initials>
<IsShared>false</IsShared>
<JobCount>0</JobCount>
<JobID>0</JobID>
<JobName>String</JobName>
<LastContact>0001-01-01T00:00:00</LastContact>
<LastName>String</LastName>
<Locked>false</Locked>
<LockedByAgentId>0</LockedByAgentId>
<LockedTimestamp>0001-01-01T00:00:00</LockedTimestamp>
<MaritalStatus>String</MaritalStatus>
<MiddleInitial>String</MiddleInitial>
<Name>String</Name>
<NumberOfDebtAccounts>0</NumberOfDebtAccounts>
<PeraContactId>0</PeraContactId>
<Phone>String</Phone>
<PhoneAlt>String</PhoneAlt>
<PhoneLabel>String</PhoneLabel>
<ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
<Rate>0</Rate>
<Role>String</Role>
<RoomNumber>String</RoomNumber>
<SMSOptIn>false</SMSOptIn>
<SSN>String</SSN>
<School>String</School>
<SchoolID>0</SchoolID>
<SourceNote>String</SourceNote>
<SourceTypeDesc>String</SourceTypeDesc>
<SourceTypeId>0</SourceTypeId>
<State>String</State>
<StateID>0</StateID>
<StateName>String</StateName>
<Tags>String</Tags>
<Title>String</Title>
<TotalDebtAmount>0</TotalDebtAmount>
<WritingAgentId>0</WritingAgentId>
<WritingAgentName>String</WritingAgentName>
<address_city>String</address_city>
<address_line1>String</address_line1>
<address_state>String</address_state>
<address_zip>String</address_zip>
</Contact>
<Expenses>
<ContactExpense>
<Balance>0</Balance>
<ContactExpenseId>0</ContactExpenseId>
<ContactId>0</ContactId>
<Description>String</Description>
<ExpenseType>String</ExpenseType>
<InterestRate>0</InterestRate>
<MinimumPayment>0</MinimumPayment>
<MonthlyPayment>0</MonthlyPayment>
</ContactExpense>
</Expenses>
<FactFinderSheet>
<ClientGrossMthlyIncome>0</ClientGrossMthlyIncome>
<ClientNetMthlyIncome>0</ClientNetMthlyIncome>
<ContactId>0</ContactId>
<ContractBaseServPerYrDays>0</ContractBaseServPerYrDays>
<ContractBaseServPerYrHours>0</ContractBaseServPerYrHours>
<DaysPerWeek>0</DaysPerWeek>
<DesiredRetirementIncome>0</DesiredRetirementIncome>
<DiscretionaryIncome>0</DiscretionaryIncome>
<EmergencyFundBalance>0</EmergencyFundBalance>
<EmergencyFundComplete>false</EmergencyFundComplete>
<EmergencyFundMthlyContrib>0</EmergencyFundMthlyContrib>
<EmploymentYears>String</EmploymentYears>
<EstimatedExpenses>0</EstimatedExpenses>
<FactFinderSheetId>0</FactFinderSheetId>
<HasDistributionPlan>false</HasDistributionPlan>
<HasPriorEmploymentRetirementSavings>false</HasPriorEmploymentRetirementSavings>
<HasRetirementSavings>false</HasRetirementSavings>
<HoursPerWeek>0</HoursPerWeek>
<HouseholdGrossMthlyIncome>0</HouseholdGrossMthlyIncome>
<HouseholdNetMthlyIncome>0</HouseholdNetMthlyIncome>
<MonthsPerYear>0</MonthsPerYear>
<NumPreTaxChecksPerYr>0</NumPreTaxChecksPerYr>
<PDIPremium>0</PDIPremium>
<PLICarrier>String</PLICarrier>
<PLICashValue>0</PLICashValue>
<PLIFaceAmount>0</PLIFaceAmount>
<PLIIssueDate>0001-01-01T00:00:00</PLIIssueDate>
<PLIPremium>0</PLIPremium>
<PLIType>String</PLIType>
<PLITypeOf>String</PLITypeOf>
<PLTCPremium>0</PLTCPremium>
<PastOccupations>String</PastOccupations>
<PrimaryDisabilityInsurance>false</PrimaryDisabilityInsurance>
<PrimaryLTCInsurance>false</PrimaryLTCInsurance>
<PrimaryLifeInsurance>false</PrimaryLifeInsurance>
<RetirementGoals>String</RetirementGoals>
<SDIPremium>0</SDIPremium>
<SLICarrier>String</SLICarrier>
<SLICashValue>0</SLICashValue>
<SLIFaceAmount>0</SLIFaceAmount>
<SLIIssueDate>0001-01-01T00:00:00</SLIIssueDate>
<SLIPremium>0</SLIPremium>
<SLIType>String</SLIType>
<SLITypeOf>String</SLITypeOf>
<SLTCPremium>0</SLTCPremium>
<SpouseDisabilityInsurance>false</SpouseDisabilityInsurance>
<SpouseLTCInsurance>false</SpouseLTCInsurance>
<SpouseLifeInsurance>false</SpouseLifeInsurance>
<UnusedSickDays>0</UnusedSickDays>
<UnusedSickHours>0</UnusedSickHours>
<WorkStatus>String</WorkStatus>
<YearsWithOtherDistricts>0</YearsWithOtherDistricts>
</FactFinderSheet>
<IncomeSources>
<ContactRetirementIncome>
<AccountOwner>String</AccountOwner>
<AccountType>String</AccountType>
<AddlFormsReqd>false</AddlFormsReqd>
<Carrier>String</Carrier>
<ContactId>0</ContactId>
<ContactRetirementIncomeId>0</ContactRetirementIncomeId>
<Contrib>0</Contrib>
<DateOfIssue>0001-01-01T00:00:00</DateOfIssue>
<EmpNotes>String</EmpNotes>
<FaxAccepted>false</FaxAccepted>
<FaxNumber>String</FaxNumber>
<Fees>0</Fees>
<HasOutstandingLoans>false</HasOutstandingLoans>
<MailingAddr>String</MailingAddr>
<MailingCity>String</MailingCity>
<MailingState>String</MailingState>
<MailingZip>String</MailingZip>
<OriginalFormsReqd>false</OriginalFormsReqd>
<PolicyNum>String</PolicyNum>
<SignatureGuarReqd>false</SignatureGuarReqd>
<SurrCharge>0</SurrCharge>
<SurrValue>0</SurrValue>
<TaxCode>String</TaxCode>
<ThirdPrtyPprwrkOK>false</ThirdPrtyPprwrkOK>
<TotalValue>0</TotalValue>
</ContactRetirementIncome>
</IncomeSources>
<LTAInfo>
<ContactLTAInfo>
<Balance>0</Balance>
<Company>String</Company>
<ContactId>0</ContactId>
<ContactLTAInfoId>0</ContactLTAInfoId>
<Contribution>0</Contribution>
<PlanType>String</PlanType>
</ContactLTAInfo>
</LTAInfo>
<Pensions>
<ContactPension>
<ContactId>0</ContactId>
<ContactPensionId>0</ContactPensionId>
<DefinedBenefitBalance>0</DefinedBenefitBalance>
<DefinedBenefitSpouseBalance>0</DefinedBenefitSpouseBalance>
<DesiredRetirementAge>0</DesiredRetirementAge>
<DesiredRetirementDate>0001-01-01T00:00:00</DesiredRetirementDate>
<FormulaAt>0</FormulaAt>
<FormulaPercent>0</FormulaPercent>
<PensionStartDate>0001-01-01T00:00:00</PensionStartDate>
<PensionSystem>String</PensionSystem>
<ServiceCredit>0</ServiceCredit>
<ServiceCreditAsOfDate>0001-01-01T00:00:00</ServiceCreditAsOfDate>
<SpousalBenefitDesired>false</SpousalBenefitDesired>
</ContactPension>
</Pensions>
<Referrals>
<ContactClientReferral>
<Campus>String</Campus>
<ContactClientReferralId>0</ContactClientReferralId>
<ContactId>0</ContactId>
<Name>String</Name>
<Phone>String</Phone>
<Room>String</Room>
</ContactClientReferral>
</Referrals>
<Spouse>
<Cell>String</Cell>
<ContactId>0</ContactId>
<ContactSpouseId>0</ContactSpouseId>
<DOB>0001-01-01T00:00:00</DOB>
<Email>String</Email>
<Employer>String</Employer>
<Name>String</Name>
<PastOccupations>String</PastOccupations>
<Position>String</Position>
<Years>0</Years>
</Spouse>
</FactFinderSheet>
</FactFinderRequest>