GET api/residents/{Id}

Get resident by specified resident ID

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
Id

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Resident
NameDescriptionTypeAdditional information
ResidentId

Resident Id. Primary key of the residents table.

 integer

None.
PropertyId

Property Id. See the GET api/properties/{propertyId} route to get the property data.

 integer

None.
UnitId

Unit Id. See the GET api/units/{unitId} route to get the unit data.

 integer

None.
ResidentFirstName

Resident First Name.

 string

None.
ResidentMiddleInitial

Resident Middle Initial.

 string

None.
ResidentLastName

Resident Last Name.

 string

None.
ResidentEmail

Resident Email.

 string

None.
ResidentUnitphone

Resident Unit Phone.

 string

None.
ResidentCellphone

Resident Cell Phone.

 string

None.
ResidentWorkphone

Resident Work Phone.

 string

None.
ResidentOtherphone

Resident Other Phone.

 string

None.
OccupancyType

Occupany Type.

 string

None.
ResidentType

Resident Type See the GET api/residenttypes route.

 integer

None.
MoveInDate

MoveInDate.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResidentId": 1,
  "PropertyId": 2,
  "UnitId": 1,
  "ResidentFirstName": "sample string 3",
  "ResidentMiddleInitial": "sample string 4",
  "ResidentLastName": "sample string 5",
  "ResidentEmail": "sample string 6",
  "ResidentUnitphone": "sample string 7",
  "ResidentCellphone": "sample string 8",
  "ResidentWorkphone": "sample string 9",
  "ResidentOtherphone": "sample string 10",
  "OccupancyType": "sample string 11",
  "ResidentType": 12,
  "MoveInDate": "2025-12-24T05:25:17.4694534-05:00"
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)