GET /api/v3/hierarchy/place/{placeId}

Returns place descendant information, useful for expanding a place node

HierarchicalPlaceV3 Permissions: BuildingsAndOrganizations (View)

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
placeId Place ID integer (int32) Required

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

HierarchicalPlaces
Property Description Type
hasActiveChildren If this place has any place children or active meter children boolean
hasActiveMeterChildren If this place has any active meter children boolean
hasChildren If this place has any children, either meters or places boolean
hasMeterChildren If this place has any meter children boolean
hasPlaceChildren If this place has any place children boolean
meterChildren List of meter children HierarchicalMeter[]
HierarchicalMeter properties
Property Description Type
active Indicates whether the Meter is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
hasEmissionSource Indicates if the meter has an Emission Source link boolean
hasWatticsDataPoint Indicates if the meter has a Smart Analytics (Wattics) Data Point link boolean
isCalculatedMeter Indicates whether the meter is a calculated meter boolean
isEsaCalculatedMeter Indicates whether the meter is an ESA calculated meter boolean
isSplitChildMeter Indicates whether the meter is a child of a split boolean
isSplitParentMeter Indicates whether the meter is a parent of a split boolean
meterCode The meter code string
meterId The meter identifier integer (int32)
meterInfo The meter info string
meterType MeterTypeChild
MeterTypeChild properties
Property Description Type
meterTypeCode string
meterTypeId integer (int32)
meterTypeInfo string
serialNumber The meter’s current serial number string
parentId The place’s parent integer (int32)
placeChildren List of place children HierarchicalPlaces2[]
HierarchicalPlaces2 properties
Property Description Type
hasActiveChildren boolean
hasActiveMeterChildren boolean
hasChildren boolean
hasMeterChildren boolean
hasPlaceChildren boolean
meterChildren HierarchicalMeter[]
HierarchicalMeter properties
Property Description Type
active Indicates whether the Meter is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
hasEmissionSource Indicates if the meter has an Emission Source link boolean
hasWatticsDataPoint Indicates if the meter has a Smart Analytics (Wattics) Data Point link boolean
isCalculatedMeter Indicates whether the meter is a calculated meter boolean
isEsaCalculatedMeter Indicates whether the meter is an ESA calculated meter boolean
isSplitChildMeter Indicates whether the meter is a child of a split boolean
isSplitParentMeter Indicates whether the meter is a parent of a split boolean
meterCode The meter code string
meterId The meter identifier integer (int32)
meterInfo The meter info string
meterType MeterTypeChild
MeterTypeChild properties
Property Description Type
meterTypeCode string
meterTypeId integer (int32)
meterTypeInfo string
serialNumber The meter’s current serial number string
parentId integer (int32)
placeChildren HierarchicalPlaces[]
HierarchicalPlaces properties
Property Description Type
hasActiveChildren If this place has any place children or active meter children boolean
hasActiveMeterChildren If this place has any active meter children boolean
hasChildren If this place has any children, either meters or places boolean
hasMeterChildren If this place has any meter children boolean
hasPlaceChildren If this place has any place children boolean
meterChildren List of meter children HierarchicalMeter[]
HierarchicalMeter properties
Property Description Type
active Indicates whether the Meter is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
hasEmissionSource Indicates if the meter has an Emission Source link boolean
hasWatticsDataPoint Indicates if the meter has a Smart Analytics (Wattics) Data Point link boolean
isCalculatedMeter Indicates whether the meter is a calculated meter boolean
isEsaCalculatedMeter Indicates whether the meter is an ESA calculated meter boolean
isSplitChildMeter Indicates whether the meter is a child of a split boolean
isSplitParentMeter Indicates whether the meter is a parent of a split boolean
meterCode The meter code string
meterId The meter identifier integer (int32)
meterInfo The meter info string
meterType MeterTypeChild
MeterTypeChild properties
Property Description Type
meterTypeCode string
meterTypeId integer (int32)
meterTypeInfo string
serialNumber The meter’s current serial number string
parentId The place’s parent integer (int32)
placeChildren List of place children HierarchicalPlaces2[]
HierarchicalPlaces2 properties
Property Description Type
hasActiveChildren boolean
hasActiveMeterChildren boolean
hasChildren boolean
hasMeterChildren boolean
hasPlaceChildren boolean
meterChildren HierarchicalMeter[]
HierarchicalMeter properties
Property Description Type
active Indicates whether the Meter is Active boolean
commodity CommodityChild
CommodityChild properties
Property Description Type
commodityCode The commodity code Required (defined) string
commodityIcon Icon
commodityId The commodity identifier Required (defined) integer (int32)
commodityInfo The commodity info Required (defined) string
hasEmissionSource Indicates if the meter has an Emission Source link boolean
hasWatticsDataPoint Indicates if the meter has a Smart Analytics (Wattics) Data Point link boolean
isCalculatedMeter Indicates whether the meter is a calculated meter boolean
isEsaCalculatedMeter Indicates whether the meter is an ESA calculated meter boolean
isSplitChildMeter Indicates whether the meter is a child of a split boolean
isSplitParentMeter Indicates whether the meter is a parent of a split boolean
meterCode The meter code string
meterId The meter identifier integer (int32)
meterInfo The meter info string
meterType MeterTypeChild
MeterTypeChild properties
Property Description Type
meterTypeCode string
meterTypeId integer (int32)
meterTypeInfo string
serialNumber The meter’s current serial number string
parentId integer (int32)
placeChildren HierarchicalPlaces[]
HierarchicalPlaces properties
Property Description Type
hasActiveChildren If this place has any place children or active meter children boolean
hasActiveMeterChildren If this place has any active meter children boolean
hasChildren If this place has any children, either meters or places boolean
hasMeterChildren If this place has any meter children boolean
hasPlaceChildren If this place has any place children boolean
meterChildren List of meter children HierarchicalMeter[]
HierarchicalMeter properties
Property Description Type
active Indicates whether the Meter is Active boolean
commodity CommodityChild
hasEmissionSource Indicates if the meter has an Emission Source link boolean
hasWatticsDataPoint Indicates if the meter has a Smart Analytics (Wattics) Data Point link boolean
isCalculatedMeter Indicates whether the meter is a calculated meter boolean
isEsaCalculatedMeter Indicates whether the meter is an ESA calculated meter boolean
isSplitChildMeter Indicates whether the meter is a child of a split boolean
isSplitParentMeter Indicates whether the meter is a parent of a split boolean
meterCode The meter code string
meterId The meter identifier integer (int32)
meterInfo The meter info string
meterType MeterTypeChild
serialNumber The meter’s current serial number string
parentId The place’s parent integer (int32)
placeChildren List of place children HierarchicalPlaces2[]
HierarchicalPlaces2 properties
Property Description Type
hasActiveChildren boolean
hasActiveMeterChildren boolean
hasChildren boolean
hasMeterChildren boolean
hasPlaceChildren boolean
meterChildren HierarchicalMeter[]
parentId integer (int32)
placeChildren HierarchicalPlaces[]
placeCode string
placeId integer (int32)
placeInfo string
placeType PlaceTypeResponse
placeTypeId integer (int32)
placeCode PlaceCode string
placeId The place’s primary ID integer (int32)
placeInfo PlaceInfo string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeTypeId PlaceTypeID integer (int32)
placeCode string
placeId integer (int32)
placeInfo string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeTypeId integer (int32)
placeCode PlaceCode string
placeId The place’s primary ID integer (int32)
placeInfo PlaceInfo string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeTypeId PlaceTypeID integer (int32)
placeCode string
placeId integer (int32)
placeInfo string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeTypeId integer (int32)
placeCode PlaceCode string
placeId The place’s primary ID integer (int32)
placeInfo PlaceInfo string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeTypeId PlaceTypeID integer (int32)
Example Response application/json 
{  "hasActiveChildren": false,  "hasActiveMeterChildren": false,  "hasChildren": false,  "hasMeterChildren": false,  "hasPlaceChildren": false,  "meterChildren": [
    {    "active": false,    "commodity": {      "commodityCode": "string",      "commodityIcon": {},      "commodityId": 1,      "commodityInfo": "string"
    },    "hasEmissionSource": false,    "hasWatticsDataPoint": false,    "isCalculatedMeter": false,    "isEsaCalculatedMeter": false,    "isSplitChildMeter": false,    "isSplitParentMeter": false,    "meterCode": "string",    "meterId": 1,    "meterInfo": "string",    "meterType": {      "meterTypeCode": "string",      "meterTypeId": 1,      "meterTypeInfo": "string"
    },    "serialNumber": "string"
  }
  ],  "parentId": 1,  "placeChildren": [
    {    "hasActiveChildren": false,    "hasActiveMeterChildren": false,    "hasChildren": false,    "hasMeterChildren": false,    "hasPlaceChildren": false,    "meterChildren": [
      {      "active": false,      "commodity": {},      "hasEmissionSource": false,      "hasWatticsDataPoint": false,      "isCalculatedMeter": false,      "isEsaCalculatedMeter": false,      "isSplitChildMeter": false,      "isSplitParentMeter": false,      "meterCode": "string",      "meterId": 1,      "meterInfo": "string",      "meterType": {},      "serialNumber": "string"
    }
    ],    "parentId": 1,    "placeChildren": [
      {      "hasActiveChildren": false,      "hasActiveMeterChildren": false,      "hasChildren": false,      "hasMeterChildren": false,      "hasPlaceChildren": false,      "meterChildren": [],      "parentId": 1,      "placeChildren": [],      "placeCode": "string",      "placeId": 1,      "placeInfo": "string",      "placeType": {},      "placeTypeId": 1
    }
    ],    "placeCode": "string",    "placeId": 1,    "placeInfo": "string",    "placeType": {      "icon": {},      "isSystemPlaceType": false,      "placeEntityType": {},      "placeTypeCode": "string",      "placeTypeId": 1,      "placeTypeInfo": "string",      "structure": false
    },    "placeTypeId": 1
  }
  ],  "placeCode": "string",  "placeId": 1,  "placeInfo": "string",  "placeType": {    "icon": {      "code": "string",      "color": "string"
    },    "isSystemPlaceType": false,    "placeEntityType": {      "placeEntityTypeId": 1,      "placeEntityTypeInfo": "string"
    },    "placeTypeCode": "string",    "placeTypeId": 1,    "placeTypeInfo": "string",    "structure": false
  },  "placeTypeId": 1
}