GET api/properties/{propertyId}/units?unitNumber={unitNumber}&residentName={residentName}&sort={sort}&page={page}&pageSize={pageSize}

Get all units for a property

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
propertyId	(Required)	integer	Required
unitNumber	(Optional)Limits the results by Unit Number.	string
residentName	(Optional)Limits the results by Resident Name.	string
sort	(Optional)The order in which to sort the returned units. Defaults to unitdisplayorder ascending. The possible values are: unitdisplayorder	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

ListWrapperOfUnit

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

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "UnitId": 1,
      "PropertyId": 2,
      "UnitNumber": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "DisplayOrder": 1,
      "Floor": 1,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    {
      "UnitId": 1,
      "PropertyId": 2,
      "UnitNumber": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "DisplayOrder": 1,
      "Floor": 1,
      "Latitude": 1.0,
      "Longitude": 1.0
    }
  ]
}

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)