Request
Data is requested by performing a HTTP Post to https://api.myresman.com/Property/GetUnits supplying the listed parameters below in the body of the request. Please refer to the Request Example portion at the beginning of this document for an example on how to make such a request.
Parameters
Name | Description | Example | Required |
IntegrationPartnerID | The ID assigned to your company by ResMan | 1000 | Yes |
ApiKey | The API key assigned to your company by ResMan | a5w7d9g2m04… | Yes |
AccountID | The AccountID associated with the property | 400 | Yes |
PropertyID | The PropertyID associated with the property | 07413576-f764-44c6-be35-df4139deec01 | Yes |
Response
The response will be provided in the format requested based upon the Accept HTTP header; either json or xml. The response will contain information about the method called, and the parameters supplied.
Name | Description |
UnitNumber | The number of the unit |
Building | The building where the unit is located |
Floor | The floor of the building where the unit is located |
StreetAddress | The street address of the unit |
City | The city of the unit |
State | The state of the unit |
Zip | The zip code of the unit |
UnitType | The unit type of the unit |
Below are examples of the response you can expect from this method.
JSON Response
{
"Units": [
{
"UnitNumber": "101",
"Building": "1",
"Floor": "1",
"StreetAddress": "123 Main St",
"City": "Denver",
"State": "CO",
"Zip": "80202",
"UnitType": "1B1b",
},
{
"UnitNumber": "201",
"Building": "1",
"Floor": "2",
"StreetAddress": "123 Main St",
"City": "Denver",
"State": "CO",
"Zip": "80202",
"UnitType": "2B2b",
}
],
"MethodName": "GetUnits",
"ErrorDescription": null,
"Status": "Success",
"AccountID": 400,
"PropertyID": "07413576-f764-44c6-be35-df4139deec01"
}
XML Response
<ResMan
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MethodName>GetUnits</MethodName>
<Status>Success</Status>
<AccountID>400</AccountID>
<PropertyID>07413576-f764-44c6-be35-df4139deec01</PropertyID>
<Units>
<Unit>
<UnitNumber>101</UnitNumber>
<Building>1</Building>
<Floor>1</Floor>
<StreetAddress>123 Main St</StreetAddress>
<City>Denver</City>
<State>CO</State>
<Zip>80202</Zip>
<UnitType>1B1b</UnitType>
</Unit>
<Unit>
<UnitNumber>201</UnitNumber>
<Building>1</Building>
<Floor>2</Floor>
<StreetAddress>123 Main St</StreetAddress>
<City>Denver</City>
<State>CO</State>
<Zip>80202</Zip>
<UnitType>2B2b</UnitType>
</Unit>
</Units>
</ResMan>