GET api/residents/{residentId}/settings

Get Resident Settings

Request Information

URI Parameters

Name	Description	Type	Additional information
residentId	Primary Resident Identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

ResidentSettingsViewModel

Name	Description	Type	Additional information
AcceptChecks	Accept Checks	boolean	None.
InLegal	In Legal	boolean	None.
PayrollDeduction	Payroll Deduction	boolean	None.
NoLateFee	No Late Fee	boolean	None.
HoldBilling	Hold Billing	boolean	None.
RecurringPayment	Recurring Payment	boolean	None.
IsSponsor	In Sponsor	boolean	None.
IsDeveloper	Is Developer	boolean	None.
InBankruptcy	In Bankruptcy	boolean	None.
Foreclosure	Foreclosure Details	ResidentForeclosureViewModel	None.
ConsolidatedBillerId	Consolidated Biller Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "acceptChecks": true,
  "inLegal": true,
  "payrollDeduction": true,
  "noLateFee": true,
  "holdBilling": true,
  "recurringPayment": true,
  "isSponsor": true,
  "isDeveloper": true,
  "inBankruptcy": true,
  "foreclosure": {
    "lendingInstitution": "sample string 1",
    "startDate": "sample string 2",
    "endDate": "sample string 3"
  },
  "consolidatedBillerId": 1
}

application/xml, text/xml

Sample:

<ResidentSettingsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Residents">
  <AcceptChecks>true</AcceptChecks>
  <ConsolidatedBillerId>1</ConsolidatedBillerId>
  <Foreclosure>
    <EndDate>sample string 3</EndDate>
    <LendingInstitution>sample string 1</LendingInstitution>
    <StartDate>sample string 2</StartDate>
  </Foreclosure>
  <HoldBilling>true</HoldBilling>
  <InBankruptcy>true</InBankruptcy>
  <InLegal>true</InLegal>
  <IsDeveloper>true</IsDeveloper>
  <IsSponsor>true</IsSponsor>
  <NoLateFee>true</NoLateFee>
  <PayrollDeduction>true</PayrollDeduction>
  <RecurringPayment>true</RecurringPayment>
</ResidentSettingsViewModel>