POST Codebooks/{QuestionKey}

Create a new Codebook for a Question.
This operation replaces any existing Codebook for the specified Question with the new Codebook.
This operation is permitted only if there are no coded responses in the Question.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
QuestionKey

The key of the Question.

integer

Required

Body Parameters

The codes and nets in the new Codebook.

NewCodebookRequest
NameDescriptionTypeAdditional information
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 NewCodeOrNet

Required

Response Information

Create a new Codebook for a Question.
This operation replaces any existing Codebook for the specified Question with the new Codebook.
This operation is permitted only if there are no coded responses in the Question.

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.