GET api/residents/findbyaccount?entityNumber={entityNumber}&buildingNumber={buildingNumber}&unitNumber={unitNumber}&residentNumber={residentNumber}&residentStatus={residentStatus}

Get resident by account number. Exclusively used by Connect gRPC. In the future, Connect gRPC will call CamAcct Resident Profile gRPC instead of this longer trip.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityNumber

string

Required

buildingNumber

string

Required

unitNumber

string

Required

residentNumber

string

Required

residentStatus

integer

Default value is 2

Body Parameters

None.

Response Information

Resource Description

ResidentAccountInfoViewModel
NameDescriptionTypeAdditional information
ResidentId

integer

None.

ResidentNumber

string

None.

UnitId

integer

None.

UnitNumber

string

None.

BuildingId

integer

None.

BuildingNumber

string

None.

EntityId

integer

None.

EntityNumber

string

None.

FirstName

string

None.

LastName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "residentId": 1,
  "residentNumber": "sample string 2",
  "unitId": 3,
  "unitNumber": "sample string 4",
  "buildingId": 5,
  "buildingNumber": "sample string 6",
  "entityId": 7,
  "entityNumber": "sample string 8",
  "firstName": "sample string 9",
  "lastName": "sample string 10"
}

application/xml, text/xml

Sample:
<ResidentAccountInfoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Residents">
  <BuildingId>5</BuildingId>
  <BuildingNumber>sample string 6</BuildingNumber>
  <EntityId>7</EntityId>
  <EntityNumber>sample string 8</EntityNumber>
  <FirstName>sample string 9</FirstName>
  <LastName>sample string 10</LastName>
  <ResidentId>1</ResidentId>
  <ResidentNumber>sample string 2</ResidentNumber>
  <UnitId>3</UnitId>
  <UnitNumber>sample string 4</UnitNumber>
</ResidentAccountInfoViewModel>