Yardi Voyager

🚧

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 Voyager are indicated by the key property being set to yardi-voyager.

📘

Something Missing?

You may notice a reference does not exist for an asset or unit even though your customer is using Yardi Voyager as a data provider. This is likely because we have yet to create these references for Yardi Voyager. 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 Yardi Voyager are matched to a VoyagerPropertyCode value, which is provided to Engrain by the customer or gathered from the Yardi API.

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

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

{
  "id": "443",
  "asset_id": "4494",
  "key": "yardi-voyager",// Indicates the asset reference is for Yardi Voyager
  "value": "iv",// The matched Yardi `VoyagerPropertyCode` value
  "created_at": "2021-12-14T20:09:59+00:00",
  "updated_at": "2021-12-14T20:09:59+00:00"
 },

📘

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

Unit Reference

Unit references for Yardi Voyager are matched to the IDType attribute on the <Identification> XML node, which are gathered from https://www.yardipcv.com/8223tp7s7dev/webservices/ItfILSGuestCard.asmx?op=UnitAvailability_Login.

👍

On June 1st, 2022, Engrain received confirmation from Yardi that this value is the unique identifier for the unit within Yardi Voyager.

A single <Identification> node will be found within the <ILS_Unit> node where IDValue attributes equal the same value. In the following example, the unit reference value will be 64601, given the IDValue attribute on <Identification> and <ILS_Unit> nodes equal the value 1004.

<ILS_Unit IDValue="1004">
  <Units>
    <Unit>
      <Identification IDValue="1004" OrganizationName="Unit" IDType="64601"/>
      <Identification IDValue="A321256" OrganizationName="UnitType" IDType="4406"/>
      ...
    </Unit>
  </Units>
  ...
</ILS_Unit>

📘

The equated IDValue attributes represent the unit number.

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

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

{
  "group_id": "2",
  "asset_id": "4098",
  "unit_id": "972433",
  "key": "yardi-voyager", // Indicates the unit reference is for Yardi Voyager
  "value": "64601", // The matched Yardi Voyager `IDType` attribute value
  "created_at": "2021-06-17T22:31:59+00:00",
  "updated_at": "2021-06-17T22:31:59+00:00"
},

📘

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