Questions represent the "question" being asked and the rules specific to how it should be presented to the user.

The Question Object

Attributes

questionId string: required The unique identifier of the question.

questionnaireId string: required The unique identifier of the questionnaire that the question belongs to.

questionType string: required

Identifies the type of responses the question supports. More information can be found in the Questionnaire Question Type Dictionary.

questionText string: required The question being asked.

questionSequence numeric: required The order in which the question should be presented in relation to other questions belonging to the same questionnaire.

questionLevel numeric: required Represents the "depth" of the question. A value of 1 represents a top-level question while a value of 2 or greater represents a follow-up question.

questionMinResponses numeric: required The minimum number of responses required to successfully respond to the question. 0 indicates no response required (i.e. an optional question).

questionMaxResponses numeric: required The maximum number of responses required to successfully respond to the question.

questionMinCharsAllowed numeric: optional The minimum number of characters required to successfully respond to the question. If the questionType has a value of strict, this value will be null.

questionMaxCharsAllowed numeric: optional The maximum number of characters required to successfully respond to the question. If the questionType has a value of strict, this value will be null.

parentQuestionId string: optional The unique identifier of the question directly linked to this question (upstream). A first follow-up question would have the primary questionId here, whereas a second follow-up question would have the first follow-up questionId here, and so on. This value will be null for top-level questions.

questionResponses list of objects: required

A list of valid Questionnaire Question Response Objects. This list will be empty for questions that only support free-form responses.

Example

{
	"questionId": "quesqu_afed4982e8134edfbd5ee85f12c3246c",
	"questionnaireId": "quesna_de8d6957e1374ad7859329ff73b7d43e",
	"questionType": "strict",
	"questionText": "How many times in the past 12 months have you used tobacco products (like cigarettes, cigars, snuff, chew, electronic cigarettes)?",
	"questionSequence": 1,
	"questionLevel": 1,
	"questionMinResponses": 1,
	"questionMaxResponses": 1,
	"questionResponseMinCharsAllowed": 0,
	"questionResponseMaxCharsAllowed": 0,
	"questionResponses": [
		{
			"responseId": "quesqr_a8549f8cf0e64cb3b3d2c48bd7e764ca",
			"response": "Never",
			"questionId": "quesqu_ad43bf224b3a4158a0333b54ed25a47f",
			"followUpQuestions": []
		},
		{
			"responseId": "quesqr_4f3f3b13e8ab406190248422681c24b7",
			"response": "Once or Twice",
			"questionId": "quesqu_ad43bf224b3a4158a0333b54ed25a47f",
			"followUpQuestions": []
		},
		{
			"responseId": "quesqr_77759930543d4fa6bf7caf34c95cb1fa",
			"response": "Monthly",
			"questionId": "quesqu_ad43bf224b3a4158a0333b54ed25a47f",
			"followUpQuestions": []
		},
		{
			"responseId": "quesqr_0051d21589da4f39991c78314f66ce9e",
			"response": "Weekly",
			"questionId": "quesqu_ad43bf224b3a4158a0333b54ed25a47f",
			"followUpQuestions": []
		},
		{
			"responseId": "quesqr_8829b3693fc74a23b52d7561eac5a8f6",
			"response": "Daily or Almost Daily",
			"questionId": "quesqu_ad43bf224b3a4158a0333b54ed25a47f",
			"followUpQuestions": []
		}
	]
}