The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
ResponseStatus,data
"{ErrorCode:String,Message:String,StackTrace:String,Errors:[{ErrorCode:String,FieldName:String,Message:String}]}","{Contact:{ContactId:0,ContactType:0,FirstName:String,LastName:String,Title:String,EmailWork:String,EmailPersonal:String,State:String,Phone:String,LastContact:0001-01-01,DoNotContact:False,AgentId:0,PhoneAlt:String,PeraContactId:0,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,AdditionalInformation:String,HasGiftCard:False,MaritalStatus:String,ContactGUID:00000000000000000000000000000000,Licenses:[{Id:0,AgentId:0,ContactId:0,AgentRegistrationTempId:0,LicenseTypeId:0,SecurityLicenseTypeId:0,LicenseTypeName:String,SecuritiesLicenseTypeName:String,LicenseState:String,LicenseNumber:String,Temporary:False,DateCreated:0001-01-01,DateModified:0001-01-01,DateAcquired:0001-01-01,ExpirationDate:0001-01-01}],Employee:{Id:0,ContactId:0,EmployerId:0,SchoolId:0,EmployerName:String,SchoolName:String,FullSSN:String,Gender:String,EmployeeId:String,DateOfHire:0001-01-01,DateOfTermination:0001-01-01,Compensation:0,HoursWorked:0,LocationId:String,RoleId:0,IsMarried:False,LastSentToIPXDate:0001-01-01,UserId:00000000000000000000000000000000,DateOfRehire:0001-01-01,EmployeeStatus:String,InternetAgreementSignedDate:0001-01-01,IPXSponsorUserId:String,PeraConnectAgentId:0},Employer:{Id:0,ContactId:0,NCESId:String,Name:String,StateId:0,Street:String,City:String,Zip:String,EmployeeCount:0,SchoolSiteCount:0,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,PayrollTriggerDate:0001-01-01,AccountType:String,EIN:String},School:{Id:0,ContactId:0,EmployerId:0,Name:String,SchoolLevelId:0,City:String,County:String,Zip:String,Zip4:String,Phone:String,Website:String,Street1:String,Street2:String,EmployeeCount:0,SchoolSiteCount:0,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,PayrollTriggerDate:0001-01-01,PayrollFrequency:String,PayrollTrigger:String,LocationId:String,Employer:{Id:0,ContactId:0,NCESId:String,Name:String,StateId:0,Street:String,City:String,Zip:String,EmployeeCount:0,SchoolSiteCount:0,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,PayrollTriggerDate:0001-01-01,AccountType:String,EIN:String}},Vendor:{Id:0,ContactId:0,Name:String,Website:String,Fax:String,IPXVendorId:String,SPARKFileSharingFrequency:String,SPARKFileSharingFrequencyOther:String,SPARKContactName:String,SPARKContactPhone:String,SPARKContactEmail:String,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,DataTransmissionMethod:String},CRMImage:String},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,RecordedMeeting:False,ExpectedRetirementAge:0,Kids:String,RetirementAccountBeneficiary:String,NeedToKnowHowThisAllWorks:False,SpouseIncome:0,HasPayStub:False,IsInterestedInAdditionalIncome:False,ExpectedSocialSecurityAge:0,ExpectedSocialSecurityAmount:0,KnowPensionIncomeWhenRetire:False,NeedRetirementIncomeQualifier:String,NeedRetirementIncomeAmount:0,SurvivorshipOption:String,HomeRentOrOwn:String,HomeMonthlyPayment:0,HomeMortgageBalance:0,HomeMonthlyExpenses:0,CCDebtPersonalLoansNumCards:0,CCDebtPersonalLoansTotalBalance:0,CCDebtPersonalLoansMonthlyPayment:0,MedicalDebtNumDebts:0,MedicalDebtTotalBalance:0,MedicalDebtMonthlyPayment:0,StudentLoansNumPrivateLoans:0,StudentLoansNumFedLoans:0,StudentLoansTotalBalance:0,StudentLoansMonthlyPayment:0,TaxDebtTotalAmount:0,TaxDebtMonthlyPayment:0,TaxDebtAvgTaxRefund:0,ImpactIfYouSpousePassedAway:String,ImpactIfYouSpouseIllInjuredUnableToWork:String,InterestedInPlanToHelpSecureFuture:False,AdditionalIncomeIfYouSpousePassedAway:0,NextAppt1Date:0001-01-01,NextAppt2Date:0001-01-01,NextApptNotes:String,AgreeToAnswerCallOrCallBack:False,AgreeToMeetOnceYear:False,AgreeToIntroduceToFriendsFamily: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,GiftCardNumber:String,ReferralContactId:0}],LTAInfo:[{ContactLTAInfoId:0,ContactId:0,PlanType:String,Company:String,Contribution:0,Balance:0,SavingFor:String,ContributionText:String}],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}],Insurances:[{ContactInsuranceId:0,ContactId:0,Company:String,CoverageAmount:0,Payment:0,IssueDate:0001-01-01,CashValue:0,LivingBenefits:False}],ReferralContacts:[{ContactId:0,ContactType:0,FirstName:String,LastName:String,Title:String,EmailWork:String,EmailPersonal:String,State:String,Phone:String,LastContact:0001-01-01,DoNotContact:False,AgentId:0,PhoneAlt:String,PeraContactId:0,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,AdditionalInformation:String,HasGiftCard:False,MaritalStatus:String,ContactGUID:00000000000000000000000000000000,Licenses:[{Id:0,AgentId:0,ContactId:0,AgentRegistrationTempId:0,LicenseTypeId:0,SecurityLicenseTypeId:0,LicenseTypeName:String,SecuritiesLicenseTypeName:String,LicenseState:String,LicenseNumber:String,Temporary:False,DateCreated:0001-01-01,DateModified:0001-01-01,DateAcquired:0001-01-01,ExpirationDate:0001-01-01}],Employee:{Id:0,ContactId:0,EmployerId:0,SchoolId:0,EmployerName:String,SchoolName:String,FullSSN:String,Gender:String,EmployeeId:String,DateOfHire:0001-01-01,DateOfTermination:0001-01-01,Compensation:0,HoursWorked:0,LocationId:String,RoleId:0,IsMarried:False,LastSentToIPXDate:0001-01-01,UserId:00000000000000000000000000000000,DateOfRehire:0001-01-01,EmployeeStatus:String,InternetAgreementSignedDate:0001-01-01,IPXSponsorUserId:String,PeraConnectAgentId:0},Employer:{Id:0,ContactId:0,NCESId:String,Name:String,StateId:0,Street:String,City:String,Zip:String,EmployeeCount:0,SchoolSiteCount:0,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,PayrollTriggerDate:0001-01-01,AccountType:String,EIN:String},School:{Id:0,ContactId:0,EmployerId:0,Name:String,SchoolLevelId:0,City:String,County:String,Zip:String,Zip4:String,Phone:String,Website:String,Street1:String,Street2:String,EmployeeCount:0,SchoolSiteCount:0,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,PayrollTriggerDate:0001-01-01,PayrollFrequency:String,PayrollTrigger:String,LocationId:String,Employer:{Id:0,ContactId:0,NCESId:String,Name:String,StateId:0,Street:String,City:String,Zip:String,EmployeeCount:0,SchoolSiteCount:0,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,PayrollTriggerDate:0001-01-01,AccountType:String,EIN:String}},Vendor:{Id:0,ContactId:0,Name:String,Website:String,Fax:String,IPXVendorId:String,SPARKFileSharingFrequency:String,SPARKFileSharingFrequencyOther:String,SPARKContactName:String,SPARKContactPhone:String,SPARKContactEmail:String,BankName:String,BankAddress:String,BankCity:String,BankState:String,BankZip:String,RoutingNumber:String,AccountNumber:String,DataTransmissionMethod:String},CRMImage:String}]}"