Versions Compared

Old Version 32

changes.mady.by.user David Hunt (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user David Hunt (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleRequired Headers
  • Authorization: Token token="<your session token here>"
  • User-Agent: dmtd-rest-api
  • Content-Type: application/json
  • X-ClientId: <the client id here> or X-ClientCode: <the client code here>

...

Info
titleOptional Headers


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.



Info
titleFields


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'

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.

level32-bit IntegerOptionalThe question level # from the guide. Required when area == 'milestones'
textstringRequiredThe text that describes the question
titlestringOptional

The text to display at the top of a grid column for Barriers & Transitions. Required when area == 'barriers', 'transitions'

responsesarrayRequiredAn array of response/score definitions
skillsarrayOptionalThe Task Analysis skills associated with the milestone question. Required when area == 'milestones'



Info
titleresponse Fields


FieldTypeOptionalDescription
scoreSingle Precision FloatRequiredValue to store as a score if this response is selected
textstringRequiredA string to display that describes this possible response
descriptionstringOptionalA description of the score to further help identify its application



Info
titleskills Fields


FieldTypeOptionalDescription
idstringRequiredThe skill identifier (e.g. '1-a')
skillstringRequiredA string to display that describes the skill
supportingbooleanRequiredtrue/false as to whether this is a 'supporting' skill (identified in assessment with a '*' after the skill id, e.g. '2-a*')



Info
titleExample

Example 1 - question_num provided

curl -X GET \
-H 'Authorization: Token token="9319224d0002e7a32b26c0686c42a0bf"' \
-H "User-Agent: dmtd-rest-api" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-ClientId: 1" \
httphttps://dataapi-sandbox.vbmappappdatamtd.com/1/protocol/area_question?area=milestones\&group=mand\&question_num=1

Example 2 - question_num omitted

curl -X GET \
-H 'Authorization: Token token="9319224d0002e7a32b26c0686c42a0bf"' \
-H "User-Agent: dmtd-rest-api" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-ClientId: 1" \
httphttps://dataapi-sandbox.vbmappappdatmtd.com/1/protocol/area_question?area=milestones\&group=mand

...