| 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 .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>