GET Codebooks/{CodebookKey}?tree={tree}

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.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CodebookKey

The Codebook key, which must be an integer value.

integer

Required

tree

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.

boolean

Default value is False

Body Parameters

None.

Response Information

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.

GetCodebookResponse
NameDescriptionTypeAdditional information
codebookKey

The key of the Codebook.

integer

Required

codebook

The Codes in the Codebook, in the order they appear in the Codebook.
Codebooks are tree structured and may be of any depth, although a depth of more than 6 is rare.
Only the leaf nodes may be applied to a response. These leaf nodes are Codes.
Nets have child codes or nets. Nets may not be used to code a response. They serve to provide structure to the Codebook.
Nets typically represent groups of related codes.

Collection of CodeOrNet

Required

errors

If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages.

Collection of string

None.