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