GET v1/units/{id}/unitstatuslist?apiKey={apiKey}
Returns a list of unit statuses for a given unit
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
UnitId of the unit |
integer |
Required |
| apiKey | string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of Unit Statuses
Collection of UnitStatusVm| Name | Description | Type | Additional information |
|---|---|---|---|
| UnitId | integer |
None. |
|
| AssociationId | integer |
None. |
|
| BuildingNumber | string |
None. |
|
| UnitNumber | string |
None. |
|
| UnitStatusCodeId | integer |
None. |
|
| UnitStatusDescription | string |
None. |
|
| StatusDate | date |
None. |
|
| AccountNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"unitId": 1,
"associationId": 2,
"buildingNumber": "sample string 3",
"unitNumber": "sample string 4",
"unitStatusCodeId": 5,
"unitStatusDescription": "sample string 6",
"statusDate": "2025-12-05T22:19:10.3665427-05:00",
"accountNumber": "000002-sample string 3-sample string 4"
},
{
"unitId": 1,
"associationId": 2,
"buildingNumber": "sample string 3",
"unitNumber": "sample string 4",
"unitStatusCodeId": 5,
"unitStatusDescription": "sample string 6",
"statusDate": "2025-12-05T22:19:10.3665427-05:00",
"accountNumber": "000002-sample string 3-sample string 4"
}
]
application/xml, text/xml
Sample:
<ArrayOfUnitStatusVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GPIWebDashboard.API.Models">
<UnitStatusVm>
<AssociationId>2</AssociationId>
<BuildingNumber>sample string 3</BuildingNumber>
<StatusDate>2025-12-05T22:19:10.3665427-05:00</StatusDate>
<UnitId>1</UnitId>
<UnitNumber>sample string 4</UnitNumber>
<UnitStatusCodeId>5</UnitStatusCodeId>
<UnitStatusDescription>sample string 6</UnitStatusDescription>
</UnitStatusVm>
<UnitStatusVm>
<AssociationId>2</AssociationId>
<BuildingNumber>sample string 3</BuildingNumber>
<StatusDate>2025-12-05T22:19:10.3665427-05:00</StatusDate>
<UnitId>1</UnitId>
<UnitNumber>sample string 4</UnitNumber>
<UnitStatusCodeId>5</UnitStatusCodeId>
<UnitStatusDescription>sample string 6</UnitStatusDescription>
</UnitStatusVm>
</ArrayOfUnitStatusVm>