POST api/residents/profile

Create Resident Profile

Request Information

URI Parameters

None.

Body Parameters

Resident Profile

CreateResidentProfileViewModel
NameDescriptionTypeAdditional information
UnitId

integer

Required

Range: inclusive between 1 and 2147483647

ResidentNumber

integer

Required

Range: inclusive between 0 and 2147483647

PrimaryResident

SaveResidentTaxIdViewModel

Required

CoResident

SaveCoResidentViewModel

None.

Status

Resident Profile Status * Past * Current * Future

string

Required

Comment

string

None.

FormerAccountNumber

Former Account Number

string

None.

BillingAddress

AddressBaseViewModel

Required

Dates

ResidentDatesViewModel

Required

RequiredSecurityDeposit

Required Security Deposit

decimal number

Range: inclusive between 0 and 79228162514264337593543950335

LeaseType

Lease Type * NoLease * NotRenewing * Pending * Renewing * Current

string

Required

Request Formats

application/json, text/json

Sample:
{
  "unitId": 1,
  "residentNumber": 1,
  "primaryResident": {
    "taxId": "sample string 1",
    "firstName": "sample string 2",
    "mi": "sample string 3",
    "lastName": "sample string 4",
    "phone": "sample string 5",
    "email": "sample string 6"
  },
  "coResident": {
    "replaceCoResident": true,
    "firstName": "sample string 2",
    "mi": "sample string 3",
    "lastName": "sample string 4",
    "phone": "sample string 5",
    "email": "sample string 6"
  },
  "status": "sample string 1",
  "comment": "sample string 2",
  "formerAccountNumber": "sample string 3",
  "billingAddress": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zipCode": "sample string 5",
    "country": "sample string 6"
  },
  "dates": {
    "receivedDate": "sample string 1",
    "enteredDate": "sample string 2",
    "moveInDate": "sample string 3",
    "moveOutDate": "sample string 4",
    "leaseBeginDate": "sample string 5",
    "leaseEndDate": "sample string 6",
    "leaseAnniversaryDate": "sample string 7",
    "leaseNoticeGivenDate": "sample string 8"
  },
  "requiredSecurityDeposit": 1.0,
  "leaseType": "sample string 4"
}

application/xml, text/xml

Sample:
<CreateResidentProfileViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Residents">
  <BillingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
  </BillingAddress>
  <CoResident>
    <Email>sample string 6</Email>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 4</LastName>
    <Mi>sample string 3</Mi>
    <Phone>sample string 5</Phone>
    <ReplaceCoResident>true</ReplaceCoResident>
  </CoResident>
  <Comment>sample string 2</Comment>
  <Dates>
    <EnteredDate>sample string 2</EnteredDate>
    <LeaseAnniversaryDate>sample string 7</LeaseAnniversaryDate>
    <LeaseBeginDate>sample string 5</LeaseBeginDate>
    <LeaseEndDate>sample string 6</LeaseEndDate>
    <LeaseNoticeGivenDate>sample string 8</LeaseNoticeGivenDate>
    <MoveInDate>sample string 3</MoveInDate>
    <MoveOutDate>sample string 4</MoveOutDate>
    <ReceivedDate>sample string 1</ReceivedDate>
  </Dates>
  <FormerAccountNumber>sample string 3</FormerAccountNumber>
  <LeaseType>sample string 4</LeaseType>
  <PrimaryResident>
    <Email>sample string 6</Email>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 4</LastName>
    <Mi>sample string 3</Mi>
    <Phone>sample string 5</Phone>
    <TaxId>sample string 1</TaxId>
  </PrimaryResident>
  <RequiredSecurityDeposit>1</RequiredSecurityDeposit>
  <ResidentNumber>1</ResidentNumber>
  <Status>sample string 1</Status>
  <UnitId>1</UnitId>
</CreateResidentProfileViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateResidentProfileViewModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.