latestOpenAPI 3.0.12026-08-10254561.9 KB
2ea4b8555197
Codebooks
Get a Codebook by its key
Each Question has exactly one Codebook, which may be shared across multiple Questions.
A Codebook is tree-structured, where the leaf nodes are Codes and non-leaf nodes are Nets. Only Codes may be used to code a Response.
This resource can return the Codes in the Codebook as a flattened list containing only the Codes, or as a tree with the full structure of the Codebook.
get/Codebooks/{codebookKey}
Path parameters
codebookKeyinteger required
The Codebook key, which must be an integer value.
Query parameters
treeboolean
Optional query parameter.
If true, return a tree-structured representation of the Codebook.
When tree=false (the default) only the Codes are returned (no Nets) as a single list.
Response
OK