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

GET

Get the document describing a node in a specific hierarchy

Responses

200: The hierarchy node was found and document is returned

Example value
{
  "type": "object",
  "properties": {
    "breadcrumbs": {
      "description": "The ancestors (nodes) of this node in the hierarchy, starting with the parent",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "has_data": {
            "description": "True if the instance has an observation for this code",
            "type": "boolean"
          },
          "label": {
            "description": "The label for this child node",
            "type": "string"
          },
          "links": {
            "description": "A list of links related to this node",
            "type": "object",
            "properties": {
              "code": {
                "description": "A link to a given resource",
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  },
                  "id": {
                    "type": "string"
                  }
                },
                "readOnly": true
              },
              "self": {
                "description": "A link to the given resource",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A url to this resource",
                    "type": "string"
                  }
                },
                "readOnly": true
              }
            },
            "readOnly": true,
            "example": {
              "code": {
                "href": "http://codelist/code-lists/clist1/codes/xyz987",
                "id": "xyz987"
              },
              "self": {
                "href": "http://hierarchy-api/hierarchies/instance_id1/dimension1"
              }
            }
          },
          "no_of_children": {
            "description": "The number of child nodes that this node has",
            "type": "integer"
          }
        },
        "readOnly": true,
        "example": {
          "has_data": "yes",
          "label": "Transport",
          "links": {
            "code": {
              "href": "http://codelist-api/code-lists/{code-list-id}/codes/01",
              "id": 987
            },
            "self": {
              "href": "http://hierarchy-api/hierarchies/{instance_id}/Special_Aggregat/123"
            }
          },
          "no_of_children": 3
        }
      }
    },
    "children": {
      "description": "The child nodes of this node in the hierarchy",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "has_data": {
            "description": "True if the instance has an observation for this code",
            "type": "boolean"
          },
          "label": {
            "description": "The label for this child node",
            "type": "string"
          },
          "links": {
            "description": "A list of links related to this node",
            "type": "object",
            "properties": {
              "code": {
                "description": "A link to a given resource",
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  },
                  "id": {
                    "type": "string"
                  }
                },
                "readOnly": true
              },
              "self": {
                "description": "A link to the given resource",
                "type": "object",
                "properties": {
                  "href": {
                    "description": "A url to this resource",
                    "type": "string"
                  }
                },
                "readOnly": true
              }
            },
            "readOnly": true,
            "example": {
              "code": {
                "href": "http://codelist/code-lists/clist1/codes/xyz987",
                "id": "xyz987"
              },
              "self": {
                "href": "http://hierarchy-api/hierarchies/instance_id1/dimension1"
              }
            }
          },
          "no_of_children": {
            "description": "The number of child nodes that this node has",
            "type": "integer"
          }
        },
        "readOnly": true,
        "example": {
          "has_data": "yes",
          "label": "Transport",
          "links": {
            "code": {
              "href": "http://codelist-api/code-lists/{code-list-id}/codes/01",
              "id": 987
            },
            "self": {
              "href": "http://hierarchy-api/hierarchies/{instance_id}/Special_Aggregat/123"
            }
          },
          "no_of_children": 3
        }
      }
    },
    "has_data": {
      "description": "True if the instance has an observation for this code",
      "type": "boolean"
    },
    "label": {
      "description": "The label for this node",
      "type": "string"
    },
    "links": {
      "description": "A list of links related to this node",
      "type": "object",
      "properties": {
        "code": {
          "description": "A link to a given resource",
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            },
            "id": {
              "type": "string"
            }
          },
          "readOnly": true
        },
        "self": {
          "description": "A link to the given resource",
          "type": "object",
          "properties": {
            "href": {
              "description": "A url to this resource",
              "type": "string"
            }
          },
          "readOnly": true
        }
      },
      "readOnly": true,
      "example": {
        "code": {
          "href": "http://codelist/code-lists/clist1/codes/xyz987",
          "id": "xyz987"
        },
        "self": {
          "href": "http://hierarchy-api/hierarchies/instance_id1/dimension1"
        }
      }
    },
    "no_of_children": {
      "description": "The number of child nodes that this node has",
      "type": "integer"
    }
  }
}

404: Instance, dimension or code not found

Example value
null

500: Failed to process the request due to an internal error

Example value
null