NameDescriptionTypeAdditional information
key

The key of the Code.
This key is used to relate a coded response to its Code in the Codebook.

integer

Required
ordinal

The sort ordinal for the Code.
Codes are displayed in the Codebook ordered by this value.

integer

Required
description

The description of the Code.
This description represents the concept expressed in the coded Response.

string

Required
inputId

A optional identifier which may be used during automatic coding of responses.
If null this field will not be present in the response.

string

None.
outputId

A optional identifier which may be used to identify the code in tabulation software.
If null this field will not be present in the response.

string

None.
regexPattern

Optional regular expression pattern which may be used for assisting human coders or for automatic coding.

string

None.
color

An optional color for the code in CSS hexadecimal six digit format, e.g. #FF0000 for red.
If the code color is the default value of #000000 (black) this field will not be present in the response.

string

None.
children

The children of a Net.
When querying for a codebook, this field will be present in the response only for Nets, and will never be present when the Codebook is requested with the tree=false parameter.
The children are listed in the order they appear in the Codebook.

Collection of CodeOrNet

None.