GET

codebookhierarchy

This resource has no direct relationship to one model. Instead, it's composed of multiple codebooks. A thorough documentation of the design of these hierarchies is available on the AmCAT wiki:

  • https://code.google.com/p/amcat/wiki/Codebook

Any filters applied to this resource translate directly to filters on codebooks. For example, you could request the hierarchy of codebook with id '5' using the following query:

  • /codebookhierarchy?id=5

Two special filters can be applied to hierarchies:

  • include_missing_parents
  • include_hidden

Each filter displayed above can either be true or false and do not rely on each other. Both default to true.

GET /api/v4/codebookhierarchy?format=api
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

[
    "Please select at most 5 codebook(s)"
]