ResMan

🚧

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

📘

Something Missing?

You may notice a reference does not exist for an asset or unit even though your customer is using ResMan as a data provider. This is likely because we have yet to create these references for ResMan. 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 ResMan are matched to a PropertyID value, which is provided to Engrain by the customer. Upon request, ResMan will supply the Property IDs. More information on how to make a request to this API endpoint can be found in ResMan's API documentation.

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

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

{
  "id": "2630",
  "asset_id": "4715",
  "key": "resman", // Indicates the asset reference is for ResMan
  "value": "b5ac2f9c-376-4c6c-983c-864d4cf8fd", // The matched ResMan `PropertyID` 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 ResMan are matched to PropertyIDandUnitID values, which are gathered from https://api.myresman.com/Property/GetUnits.

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

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

{
  "group_id": "9680",
  "asset_id": "862",
  "unit_id": "5654453",
  "key": "resman", // Indicates the unit reference is for ResMan
  "value": "b5ac2f9c-376-4c6c-983c-864d4cf8fd_65a638f4-9770-4109-a37e-59af293bc7", // The matched ResMan `PropertyID_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 PropertyID_UnitID.

📘

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