Sign in

v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-14274.8 KB

Get a specific node in a hierarchy

Get the document describing a node in a specific hierarchy

get/hierarchies/{instance_id}/{dimension_name}/{code_id}

Response

The hierarchy node was found and document is returned

has_databoolean

True if the instance has an observation for this code

labelstring

The label for this node

no_of_childreninteger

The number of child nodes that this node has

Example response

{
  "breadcrumbs": [
    {
      "has_data": "yes",
      "label": "Transport",
      "links": {
        "self": {
          "href": "http://hierarchy-api/hierarchies/{instance_id}/Special_Aggregat/123"
        },
        "code": {
          "href": "http://codelist-api/code-lists/{code-list-id}/codes/01",
          "id": 987
        }
      },
      "no_of_children": 3
    }
  ],
  "children": [
    {
      "has_data": "yes",
      "label": "Transport",
      "links": {
        "self": {
          "href": "http://hierarchy-api/hierarchies/{instance_id}/Special_Aggregat/123"
        },
        "code": {
          "href": "http://codelist-api/code-lists/{code-list-id}/codes/01",
          "id": 987
        }
      },
      "no_of_children": 3
    }
  ],
  "links": {
    "code": {
      "href": "http://codelist/code-lists/clist1/codes/xyz987",
      "id": "xyz987"
    },
    "self": {
      "href": "http://hierarchy-api/hierarchies/instance_id1/dimension1"
    }
  }
}