RealPage OneSite
Experimental Feature
The References API is currently an experimental feature. Therefore, the API and this documentation is subject to change. If you have any questions, please email Engrain Support.
Introduction
References for RealPage OneSite are indicated by the key
property being set to realpage-onesite
.
Something Missing?
You may notice a reference does not exist for an asset or unit even though your customer is using RealPage OneSite as a data provider. This is likely because we have yet to create these references for RealPage OneSite. Engrain must first gather and match the values for each asset and unit. If this is the case, and you are interested in references being provided, please email Engrain Support.
Asset Reference
Asset references for RealPage OneSite are matched to a PmcID
and SiteID
value provided to us by the client. We additionally use these values as input parameters to https://onesite.realpage.com/WebServices/CrossFire/AvailabilityAndPricing/Unit.asmx?op=List
The following cURL request will only list RealPage OneSite asset references for which the API Key has access to.
curl 'https://api.unitmap.com/v1/assets/references?key=realpage-onesite' \
-H 'API-key: API_KEY_GOES_HERE' \
-H 'Experimental-Flags: references'
{
"id": "2630",
"asset_id": "4715",
"key": "realpage-onesite", // Indicates the asset reference is for RealPage OneSite
"value": "2690747-4412165", // The matched RealPage OneSite `PmcID-SiteID` value
"created_at": "2021-12-16T22:48:32+00:00",
"updated_at": "2021-12-16T22:48:32+00:00"
}
value
FormatThe format of the
value
property will be eitherPmcID-SiteID
orPmcID-SiteID-SiteID
in cases where a single asset is mapped to multiple OneSite property instances.
For more detail on this API request, see https://api.unitmap.com/v1/openapi#tag/assetsreferences
Unit Reference
Unit references for RealPage OneSite are matched to a UnitID
value, which is gathered from https://onesite.realpage.com/WebServices/CrossFire/AvailabilityAndPricing/Unit.asmx?op=List or https://onesite.realpage.com/WebServices/CrossFire/AvailabilityAndPricing/PickList.asmx?op=GetPickList.
The following cURL request will only list RealPage OneSite unit references for which the API Key has access to.
curl 'https://api.unitmap.com/v1/units/references?key=realpage-onesite' \
-H 'API-key: API_KEY_GOES_HERE' \
-H 'Experimental-Flags: references'
{
"group_id": "5660",
"asset_id": "4715",
"unit_id": "258670",
"key": "realpage-onesite", // Indicates the unit reference is for RealPage OneSite
"value": "4412165-159", // The matched RealPage OneSite `SiteID-UnitID` value
"created_at": "2021-12-16T22:51:10+00:00",
"updated_at": "2021-12-16T22:51:10+00:00"
}
value
FormatThe format of the
value
property isSiteID-UnitID
.
For more detail on this API request, see https://api.unitmap.com/v1/openapi#tag/unitsreferences
Updated 6 months ago