Entrata

🚧

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 Entrata are indicated by the key property being set to entrata.

📘

Something Missing?

You may notice a reference does not exist for an asset or unit even though your customer is using Entrata as a data provider. This is likely because we have yet to create these references for Entrata. 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 Entrata are matched to a PropertyId value, which is provided to Engrain by the customer or gathered from https://www.entrata.com/api/v1/documentation/getProperties.

The following cURL request will only list Entrata asset references for which the API Key has access to.

curl 'https://api.unitmap.com/v1/assets/references?key=entrata' \
  -H 'API-key: API_KEY_GOES_HERE' \
  -H 'Experimental-Flags: references'

{
  "id": "2630",
  "asset_id": "4715",
  "key": "entrata", // Indicates the asset reference is for Entrata
  "value": "1105374", // The matched Entrata `PropertyId` value
  "created_at": "2021-12-16T22:48:32+00:00",
  "updated_at": "2021-12-16T22:48:32+00:00"
}

📘

For more detail on this API request, see https://api.unitmap.com/v1/openapi#tag/assetsreferences

Unit Reference

Unit references for Entrata may be matched to two different key values for consumer convenience. The keys are outlined below and each represent a mapping to specific Entrata resources.

entrata reference key

The entrata key is matched to the Id attribute on the UnitSpace object, which is gathered from https://www.entrata.com/api/v1/documentation/getUnitsAvailabilityAndPricing or https://www.entrata.com/api/v1/documentation/getPropertyUnits.

👍

The entrata key is our preferred and recommended Entrata reference to use. The unit space represents the rentable spaces of an asset and a unit may have more than one unit space.

The following cURL request will only list Entrata unit references with the entrata key for which the API Key has access to.

curl 'https://api.unitmap.com/v1/units/references?key=entrata' \
  -H 'API-key: API_KEY_GOES_HERE' \
  -H 'Experimental-Flags: references'

{
  "group_id": "5660",
  "asset_id": "4715",
  "unit_id": "258670",
  "key": "entrata", // Indicates the unit reference is for Entrata Unit Space IDs
  "value": "7013753", // The matched Entrata `unitSpaceId` value
  "created_at": "2021-12-16T22:51:10+00:00",
  "updated_at": "2021-12-16T22:51:10+00:00"
}

entrata-unit-ids reference key

The entrata-unit-ids key is matched to the Id attribute on the PropertyUnit object, which is gathered from https://www.entrata.com/api/v1/documentation/getUnitsAvailabilityAndPricing or https://www.entrata.com/api/v1/documentation/getPropertyUnits.

The following cURL request will only list Entrata unit references with the entrata-unit-ids key for which the API Key has access to.

curl 'https://api.unitmap.com/v1/units/references?key=entrata-unit-ids' \
  -H 'API-key: API_KEY_GOES_HERE' \
  -H 'Experimental-Flags: references'

{
  "group_id": "5660",
  "asset_id": "4715",
  "unit_id": "258670",
  "key": "entrata-unit-ids", // Indicates the unit reference is for Entrata Unit IDs
  "value": "7013753", // The matched Entrata `unitId` value
  "created_at": "2021-12-16T22:51:10+00:00",
  "updated_at": "2021-12-16T22:51:10+00:00"
}

📘

For more detail on this API request, see https://api.unitmap.com/v1/openapi#tag/unitsreferences