GET api/residents/search?entityId={entityId}&formerAccountNumber={formerAccountNumber}&residentName={residentName}&address={address}&city={city}&state={state}&postalCode={postalCode}&country={country}&maximumSearchResults={maximumSearchResults}
Get resident by parameters
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
entityId |
|
integer |
None. |
formerAccountNumber |
|
string |
None. |
residentName |
|
string |
None. |
address |
|
string |
None. |
city |
|
string |
None. |
state |
|
string |
None. |
postalCode |
|
string |
None. |
country |
|
string |
None. |
maximumSearchResults |
|
integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
Collection of ResidentSearchViewModelName | Description | Type | Additional information |
---|---|---|---|
ResidentId |
|
integer |
None. |
PrimaryResidentId |
|
integer |
None. |
UnitId |
|
integer |
None. |
BuildingId |
|
integer |
None. |
EntityId |
|
integer |
None. |
ResidentFullName |
|
string |
None. |
ResidentAccountNumber |
|
string |
None. |
FormerAccountNumber |
|
string |
None. |
EntityInformation |
|
string |
None. |
BuildingInformation |
|
string |
None. |
Status |
|
string |
None. |
UnitAddress |
|
AddressBaseViewModel |
None. |
BillingAddress |
|
AddressBaseViewModel |
None. |
Response Formats
application/json, text/json
[ { "residentId": 1, "primaryResidentId": 1, "unitId": 2, "buildingId": 3, "entityId": 4, "residentFullName": "sample string 5", "residentAccountNumber": "sample string 6", "formerAccountNumber": "sample string 7", "entityInformation": "sample string 8", "buildingInformation": "sample string 9", "status": "sample string 10", "unitAddress": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zipCode": "sample string 5", "country": "sample string 6" }, "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" } }, { "residentId": 1, "primaryResidentId": 1, "unitId": 2, "buildingId": 3, "entityId": 4, "residentFullName": "sample string 5", "residentAccountNumber": "sample string 6", "formerAccountNumber": "sample string 7", "entityInformation": "sample string 8", "buildingInformation": "sample string 9", "status": "sample string 10", "unitAddress": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zipCode": "sample string 5", "country": "sample string 6" }, "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" } } ]
application/xml, text/xml
<ArrayOfResidentSearchViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Residents"> <ResidentSearchViewModel> <BillingAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address"> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:State>sample string 4</d3p1:State> <d3p1:ZipCode>sample string 5</d3p1:ZipCode> </BillingAddress> <BuildingId>3</BuildingId> <BuildingInformation>sample string 9</BuildingInformation> <EntityId>4</EntityId> <EntityInformation>sample string 8</EntityInformation> <FormerAccountNumber>sample string 7</FormerAccountNumber> <PrimaryResidentId>1</PrimaryResidentId> <ResidentAccountNumber>sample string 6</ResidentAccountNumber> <ResidentFullName>sample string 5</ResidentFullName> <ResidentId>1</ResidentId> <Status>sample string 10</Status> <UnitAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address"> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:State>sample string 4</d3p1:State> <d3p1:ZipCode>sample string 5</d3p1:ZipCode> </UnitAddress> <UnitId>2</UnitId> </ResidentSearchViewModel> <ResidentSearchViewModel> <BillingAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address"> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:State>sample string 4</d3p1:State> <d3p1:ZipCode>sample string 5</d3p1:ZipCode> </BillingAddress> <BuildingId>3</BuildingId> <BuildingInformation>sample string 9</BuildingInformation> <EntityId>4</EntityId> <EntityInformation>sample string 8</EntityInformation> <FormerAccountNumber>sample string 7</FormerAccountNumber> <PrimaryResidentId>1</PrimaryResidentId> <ResidentAccountNumber>sample string 6</ResidentAccountNumber> <ResidentFullName>sample string 5</ResidentFullName> <ResidentId>1</ResidentId> <Status>sample string 10</Status> <UnitAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address"> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:State>sample string 4</d3p1:State> <d3p1:ZipCode>sample string 5</d3p1:ZipCode> </UnitAddress> <UnitId>2</UnitId> </ResidentSearchViewModel> </ArrayOfResidentSearchViewModel>