Yardi RentCafe

🚧

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 Yardi RentCafe are indicated by the key property being set to yardi-rentcafe.

📘

Something Missing?

You may notice a reference does not exist for an asset or unit even though your customer is using Yardi RentCafe as a data provider. This is likely because we have yet to create these references for Yard RentCafe and we 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 Yardi RentCafe are matched to a PropertyId value, which is provided to Engrain by the customer or gathered from https://api.rentcafe.com/rentcafeapi.aspx?requestType=property. More information on how to make a request to this API endpoint can be found in Yardi RentCafe's API documentation.

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

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

{
  "id": "488",
  "asset_id": "11146",
  "key": "yardi-rentcafe",// Indicates the asset reference is for Yardi RentCafe
  "value": "19125",// The matched Yardi RentCafe `PropertyId` value
  "created_at": "2021-12-20T20:53:31+00:00",
  "updated_at": "2021-12-20T20:53:31+00:00"
 },

📘

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

Unit Reference

Unit references for Yardi RentCafe are matched to an ApartmentId value, which is gathered from https://api.rentcafe.com/rentcafeapi.aspx?requestType=apartmentavailability&showallunit=-1. More information on how to make a request to this API endpoint can be found in Yardi RentCafe's API documentation.

The following cURL request will only list Yardi RentCafe unit references for which the API Key has access to.

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

{
 "group_id": "55",
 "asset_id": "758",
 "unit_id": "224563",
 "key": "yardi-rentcafe",// Indicates the unit reference is for Yardi RentCafe
 "value": "14678078",// The matched Yardi RentCafe `ApartmentId` value
 "created_at": "2021-10-19T16:10:12+00:00",
 "updated_at": "2021-10-19T16:10:12+00:00"
},

📘

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