GET api/residents/{residentId}/profile
Get Resident Profile
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
residentId |
Primary Resident Identifier |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Resident Profile
ResidentProfileViewModelName | Description | Type | Additional information |
---|---|---|---|
PrimaryResident |
|
ResidentTaxIdViewModel |
None. |
CoResident |
|
ResidentSummaryViewModel |
None. |
Status |
Resident Profile Status * Past * Current * Future |
string |
None. |
ConnectId |
Connect Resident Identifier |
integer |
None. |
Comment |
|
string |
None. |
FormerAccountNumber |
Former Account Number |
string |
None. |
BillingAddress |
|
AddressBaseViewModel |
None. |
Dates |
|
ResidentDatesViewModel |
None. |
RequiredSecurityDeposit |
Required Security Deposit |
decimal number |
None. |
LeaseType |
Lease Type * NoLease * NotRenewing * Pending * Renewing * Current |
string |
None. |
Response Formats
application/json, text/json
{ "primaryResident": { "taxId": "sample string 1", "residentId": 2, "residentNumber": "sample string 3", "firstName": "sample string 4", "mi": "sample string 5", "lastName": "sample string 6", "phone": "sample string 7", "email": "sample string 8" }, "coResident": { "residentId": 1, "residentNumber": "sample string 2", "firstName": "sample string 3", "mi": "sample string 4", "lastName": "sample string 5", "phone": "sample string 6", "email": "sample string 7" }, "status": "sample string 1", "connectId": 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
<ResidentProfileViewModel 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 7</Email> <FirstName>sample string 3</FirstName> <LastName>sample string 5</LastName> <Mi>sample string 4</Mi> <Phone>sample string 6</Phone> <ResidentId>1</ResidentId> <ResidentNumber>sample string 2</ResidentNumber> </CoResident> <Comment>sample string 2</Comment> <ConnectId>1</ConnectId> <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 8</Email> <FirstName>sample string 4</FirstName> <LastName>sample string 6</LastName> <Mi>sample string 5</Mi> <Phone>sample string 7</Phone> <ResidentId>2</ResidentId> <ResidentNumber>sample string 3</ResidentNumber> <TaxId>sample string 1</TaxId> </PrimaryResident> <RequiredSecurityDeposit>1</RequiredSecurityDeposit> <Status>sample string 1</Status> </ResidentProfileViewModel>