Item - Essay

Item Resource - Essay

The essay question type requires the candidate to write an extended response to answer the question. This is a human marked question type and the author can limit the number of characters the candidate can enter and they can configure if the candidate can format the response.  This question type is also available to use as a survey item type, all properties remain the same but the "Survey" type is returned as part of the mutual properties.



To build a POST request to the item resource the body should include any top level property required on the item, further information about these properties can be found on the item resource help page, this would then be followed by the question type collection. The collection required for essay questions, including the mandatory minimum properties is as follows:

...
"essayQuestions": [
{
"maxCharacters": 5000
{
]
...

This collection would include all of the question specific properties required. The table below identifies all of these properties including its name, type, description, default value and if it is mandatory in a request. We have also provided sample requests for the POST and GET/{id} methods in XML and JSON format:

GET/{id} - Item Essay - JSON Example
GET/{id} - Item Essay - XML Example
Property Name Type Description Default Value
(POST)
Mandatory for
create (POST)
enableTextFormatting boolean This flag identifies if the formatting will be available to the candidae in delivery true
maxCharacters int The maximum number of characters allowed in the essay response n/a X
(Draft/Live)
displayCounter boolean This flag identifies if the word counter is displayed to the candidate false
numberOfLinesPerResponse int This values identifies the number of lines provided to the candidate if the question is generated on paper 0
wordCounterLabel string The label of the counter that is displayed to the candidate in delivery. null

Feedback and Knowledge Base