GET /api/v202306/hierarchy/ancestry/collection/{collectionId}

Returns collection ancestry information, useful for populating a tree of collections

HierarchicalAncestryCollectionsV202306 Permissions: Collections (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
collectionId Collection ID integer (int32) Required

Responses

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

Response Body Parameters

HierarchicalCollections
Property Description Type
collectionChildren List of collection children HierarchicalCollections2[]
HierarchicalCollections2 properties
Property Description Type
collectionChildren HierarchicalCollections[]
HierarchicalCollections properties
Property Description Type
collectionChildren List of collection children HierarchicalCollections2[]
HierarchicalCollections2 properties
Property Description Type
collectionChildren HierarchicalCollections[]
HierarchicalCollections properties
Property Description Type
collectionChildren List of collection children HierarchicalCollections2[]
HierarchicalCollections2 properties
Property Description Type
collectionChildren HierarchicalCollections[]
collectionCode string
collectionIcon Icon
collectionId integer (int32)
collectionInfo string
emissionSourceChildren HierarchicalEmissionSource[]
hasActiveChildren boolean
hasActiveEmissionSourceChildren boolean
hasChildren boolean
hasCollectionChildren boolean
hasEmissionSourceChildren boolean
parentId integer (int32)
collectionCode The collection code string
collectionIcon 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
collectionId The collection’s primary ID integer (int32)
collectionInfo The collection info string
emissionSourceChildren List of emission source children HierarchicalEmissionSource[]
HierarchicalEmissionSource properties
Property Description Type
active Whether the emission source is active or not boolean
commodity CommodityChild
emissionSourceCode The emission source code string
emissionSourceId The emission source identifier integer (int32)
emissionSourceInfo The emission source info string
hasEUMMeter Indicates if the emission source has a EUM Meter link boolean
hasActiveChildren If this collection has any collection children or active emission source children boolean
hasActiveEmissionSourceChildren If this collection has any active emission source children boolean
hasChildren If this collection has any children, either emission sources or collections boolean
hasCollectionChildren If this collection has any collection children boolean
hasEmissionSourceChildren If this collection has any emission source children boolean
parentId The collection’s parent integer (int32)
collectionCode string
collectionIcon 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
collectionId integer (int32)
collectionInfo string
emissionSourceChildren HierarchicalEmissionSource[]
HierarchicalEmissionSource properties
Property Description Type
active Whether the emission source is active or not 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
emissionSourceCode The emission source code string
emissionSourceId The emission source identifier integer (int32)
emissionSourceInfo The emission source info string
hasEUMMeter Indicates if the emission source has a EUM Meter link boolean
hasActiveChildren boolean
hasActiveEmissionSourceChildren boolean
hasChildren boolean
hasCollectionChildren boolean
hasEmissionSourceChildren boolean
parentId integer (int32)
collectionCode The collection code string
collectionIcon 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
collectionId The collection’s primary ID integer (int32)
collectionInfo The collection info string
emissionSourceChildren List of emission source children HierarchicalEmissionSource[]
HierarchicalEmissionSource properties
Property Description Type
active Whether the emission source is active or not 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
emissionSourceCode The emission source code string
emissionSourceId The emission source identifier integer (int32)
emissionSourceInfo The emission source info string
hasEUMMeter Indicates if the emission source has a EUM Meter link boolean
hasActiveChildren If this collection has any collection children or active emission source children boolean
hasActiveEmissionSourceChildren If this collection has any active emission source children boolean
hasChildren If this collection has any children, either emission sources or collections boolean
hasCollectionChildren If this collection has any collection children boolean
hasEmissionSourceChildren If this collection has any emission source children boolean
parentId The collection’s parent integer (int32)
collectionCode string
collectionIcon 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
collectionId integer (int32)
collectionInfo string
emissionSourceChildren HierarchicalEmissionSource[]
HierarchicalEmissionSource properties
Property Description Type
active Whether the emission source is active or not 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
emissionSourceCode The emission source code string
emissionSourceId The emission source identifier integer (int32)
emissionSourceInfo The emission source info string
hasEUMMeter Indicates if the emission source has a EUM Meter link boolean
hasActiveChildren boolean
hasActiveEmissionSourceChildren boolean
hasChildren boolean
hasCollectionChildren boolean
hasEmissionSourceChildren boolean
parentId integer (int32)
collectionCode The collection code string
collectionIcon 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
collectionId The collection’s primary ID integer (int32)
collectionInfo The collection info string
emissionSourceChildren List of emission source children HierarchicalEmissionSource[]
HierarchicalEmissionSource properties
Property Description Type
active Whether the emission source is active or not 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
emissionSourceCode The emission source code string
emissionSourceId The emission source identifier integer (int32)
emissionSourceInfo The emission source info string
hasEUMMeter Indicates if the emission source has a EUM Meter link boolean
hasActiveChildren If this collection has any collection children or active emission source children boolean
hasActiveEmissionSourceChildren If this collection has any active emission source children boolean
hasChildren If this collection has any children, either emission sources or collections boolean
hasCollectionChildren If this collection has any collection children boolean
hasEmissionSourceChildren If this collection has any emission source children boolean
parentId The collection’s parent integer (int32)
Example Response application/json 
{  "collectionChildren": [
    {    "collectionChildren": [
      {      "collectionChildren": [],      "collectionCode": "string",      "collectionIcon": {},      "collectionId": 1,      "collectionInfo": "string",      "emissionSourceChildren": [],      "hasActiveChildren": false,      "hasActiveEmissionSourceChildren": false,      "hasChildren": false,      "hasCollectionChildren": false,      "hasEmissionSourceChildren": false,      "parentId": 1
    }
    ],    "collectionCode": "string",    "collectionIcon": {      "code": "string",      "color": "string"
    },    "collectionId": 1,    "collectionInfo": "string",    "emissionSourceChildren": [
      {      "active": false,      "commodity": {},      "emissionSourceCode": "string",      "emissionSourceId": 1,      "emissionSourceInfo": "string",      "hasEUMMeter": false
    }
    ],    "hasActiveChildren": false,    "hasActiveEmissionSourceChildren": false,    "hasChildren": false,    "hasCollectionChildren": false,    "hasEmissionSourceChildren": false,    "parentId": 1
  }
  ],  "collectionCode": "string",  "collectionIcon": {    "code": "string",    "color": "string"
  },  "collectionId": 1,  "collectionInfo": "string",  "emissionSourceChildren": [
    {    "active": false,    "commodity": {      "commodityCode": "string",      "commodityIcon": {},      "commodityId": 1,      "commodityInfo": "string"
    },    "emissionSourceCode": "string",    "emissionSourceId": 1,    "emissionSourceInfo": "string",    "hasEUMMeter": false
  }
  ],  "hasActiveChildren": false,  "hasActiveEmissionSourceChildren": false,  "hasChildren": false,  "hasCollectionChildren": false,  "hasEmissionSourceChildren": false,  "parentId": 1
}