MRI

🚧

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

📘

Something Missing?

You may notice a reference does not exist for an asset or unit even though your customer is using MRI as a data provider. This is likely because we have yet to create these references for MRI. 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 MRI are matched to a RMPropID value, which is provided to Engrain by the customer or gathered from https://example.mrisoftware.net/MRIWeb/MriApiServices/data/pipeline/MRI_S-DPLRM_RMPROP. More information on how to make a request to this API endpoint can be found in MRI's API documentation.

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

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

{
  "id": "2630",
  "asset_id": "4715",
  "key": "mri", // Indicates the asset reference is for MRI
  "value": "22-02", // The matched MRI  `RMPropID` value
  "created_at": "2023-12-16T22:48:32+00:00",
  "updated_at": "2023-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 MRI are matched to RMPropID,RMBldgIDandUnitID values, which are gathered from https://example.mrisoftware.com/mriapiservices/api.asp?$api=MRI_S-PMRM_ResidentialUnitAvailability&RMPROPID=TESTPP and https://example.mrisoftware.net/MRIWeb/MriApiServices/data/pipeline/MRI_S-DPLRM_RMPROP

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

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

{
  "group_id": "5660",
  "asset_id": "4715",
  "unit_id": "258670",
  "key": "mri", // Indicates the unit reference is for MRI
  "value": "22-02_02_101", // The matched MRI `RMProp_ID_RMBldgID_UnitID` value
  "created_at": "2021-12-16T22:51:10+00:00",
  "updated_at": "2021-12-16T22:51:10+00:00"
}

🚧

value Format

The format of the value property is RMPropID_RMBldgID_UnitID.

📘

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