GET residentapi/units/{unitId}/occupants?sort={sort}&page={page}&pageSize={pageSize}

Get Occupants by Unit Id

Request Information

URI Parameters

Name	Description	Type	Additional information
unitId	(Required)	integer	Required
sort	(Optional) The order in which to sort the returned occupants. Defaults to occupant last name ascending. The possible values are: lastname, firstname	string
page	(Optional)The page number of returned records based on the page size	integer	0
pageSize	(Optional)The number of records to return per page	integer	0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfOccupantMin

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of OccupantMin	None.

Response Formats

application/json, text/json

Sample:

{
  "total": 1,
  "elements": [
    {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "occupantTypeId": 3
    },
    {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "occupantTypeId": 3
    }
  ]
}