Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added support for Task Analysis

...

Info
titleArguments
FieldTypeOptionalDescription
areastringRequiredOne of the area strings retrieved from the /1/protocol/index endpoint
groupstringRequiredOne of the group strings retrieved from the /1/protocol/index endpoint
question_num32-bit IntegerOptional

The number of the question that must be 0..question_count-1 of the question_count field retrieved from the /1/protocol/index endpoint.

If question_num is omitted, the result will be an array containing all of the question entries for the given area and group.

skill_num32-bit IntegerOptional

The skill number that corresponds to a question that must be 0..skill_count-1 of the skill_count field retrieved from the /1/protocol/index endpoint.

If skill_count is omitted, the result will be an array containing all of the sub question entries for the given area, group and question_num.

Info
titleFields
level
FieldTypeOptionalDescription
definitionstringRequiredA formal definition for the question. Deprecated, use text
examplestringOptionalAn example of how the question might be administered. Required when area == 'milestones'
materialsstringOptionalInformation about what materials might be required to administer the question. Required when area == 'milestones'
objectivestringOptionalThe objective of the question. Required when area == 'milestones'
number32-bit IntegerOptional

The question # from the guide. Required when area == 'milestones', 'barriers', 'transitions', 'taskanalysis'.

Note: This is not the same as question_num, which is the programmatic index of the question. This is what to display to the user to related the question to the guide.

the guide.

level32-bit IntegerOptionalThe question level # from the guide. Required when area == 'milestones' or 'taskanalysis'
skill_number32-bit IntegerOptionalThe question level # from the guideskill_number (0..skill_count-1) for the question. Required when area == 'milestonestaskanalysis'
textstringRequiredThe text that describes the question
titlestringOptional

The text to display at the top of a grid column for Barriers & Transitions. The skill identifier (e.g. '1-a') for Task Analysis.

Required when area == 'barriers', 'transitions', 'taskanalysis'

responsesarrayRequiredAn array of response/score definitions

...