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 Marisa Paukovich.

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 Marisa Paukovich.

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 are matched to two different values for consumer convenience, separated by keys within the Unit Map api. The keys are outlined below and will each represent a mapping to specific Entrata unit identifier values.

key = "entrata" will be mapped to UnitSpace => ID value, which is gathered from https://www.entrata.com/api/v1/documentation/getUnitsAvailabilityAndPricing or https://www.entrata.com/api/v1/documentation/getPropertyUnits.

This is the preferred key as the space id will more accurately represent the individual space of an asset.

The following cURL request will only list Entrata unit references for 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 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"
}

key = "entrata-unit-ids" will be mapped to PropertyUnit => ID value, 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 for 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