Overview
Required Headers
- Authorization: Token token="<your session token here>"
- Content-Type: application/json
- X-ClientId: <the client id here> or X-ClientCode: <the client code here>
Optional Headers
- X-DocType: text or html – see Content Formatting for more information
- Accept-Language: <language> – see Content Formatting for more information
Arguments
Field | Type | Optional | Description |
---|---|---|---|
area | string | Required | One of the area strings retrieved from the /1/protocol/index endpoint |
group | string | Required | One of the group strings retrieved from the /1/protocol/index endpoint |
question_num | 32-bit Integer | Optional | 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 omitted, the result will be an array containing all of the question entries for the given area and group. |
Fields
Field | Type | Optional | Description |
---|---|---|---|
definition | string | Required | A formal definition for the question |
example | string | Optional | An example of how the question might be administered |
materials | string | Optional | Information about what materials might be required to administer the question. Required when area == 'milestones' |
objective | string | Required | The objective of the question |
number | 32-bit Integer | Optional | 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. |
level | 32-bit Integer | Optional | The question level # from the guide. Required when area == 'milestones' |
text | string | Required | The text that describes the question |
title | string | Optional | The text to display at the top of a grid column. Required when area == 'barriers', 'transitions' |
responses | array | Required | An array of response/score definitions |
response Fields
Field | Type | Optional | Description |
---|---|---|---|
score | Single Precision Float | Required | Value to store as a score if this response is selected |
text | string | Required | A string to display that describes this possible response |
description | string | Optional | A description of the score to further help identify its application |
Example
Example 1 - question_num provided
curl -X GET \
-H 'Authorization: Token token="9319224d0002e7a32b26c0686c42a0bf"' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-ClientId: 1" \
http://data-sandbox.vbmappapp.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 "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-ClientId: 1" \
http://data-sandbox.vbmappapp.com/1/protocol/area_question?area=milestones\&group=mand
Response
Example 1
{ "response": { "definition": "Emits 4 different mands without prompts (except, What do you want?) the desired item can be present (e.g., music, Slinky, ball). (E)", "example": "A child says or signs \u201cswing\u201d when he is on a swing and wants to be pushed, and he does so without an echoic or imitative prompt.", "materials": "Gather items or plan actions that function as reinforcement for the child.", "objective": "To determine if a child mands with echoic prompts. For a child ... necessary.", "number": 2, "text": "Emits 4 different mands without prompts (except, What do you want?) the desired item can be present (e.g., music, Slinky, ball) Either testing or observation", "title": null, "responses": [ { "score": 0, "text": "Score 0 Points", "description": "" }, { "score": 0.5, "text": "Score 1\/2 Point", "description": "" }, { "score": 1, "text": "Score 1 Point", "description": "Give the child 1 point if he mands for 4 different reinforcers ... (or something similar)." } ] } }
Example 2
{ "response": [ { "definition": "Emits 2 words, signs, or PECS, but may require echoic, imitative, or other prompts, but no physical prompts (e.g., cracker, book). (E)", "examples": "A child says “cookie” when he wants a cookie, but he needs an echoic prompt in order to respond. ... for action.", "guidePageNumber": 27, "level": 1, "materials": "Gather items or plan actions that function as reinforcement for the child.", "objective": "To determine if a child mands with echoic prompts. For a child using ... be necessary.", "title": "Mand - Level 1" }, "guidePageNumber": 27, "questionNumber": 1, "questionText": "Emits 2 words, signs, or PECS, but may require echoic, imitative, or other prompts, but no physical prompts (e.g., cracker, book) Either testing or observation", "questionType": "E", "responses": [ { "score": 0, "text": "Score 0 Points", "description": "" }, { "score": 0.5, "text": "Score 1\/2 Point", "description": "Give the child \u00bd point if he only emits 1 mand." }, { "score": 1, "text": "Score 1 Point", "description": "Give the child 1 point if ... icon." } ] },
{ "response": [ { "definition": "Emits 2 words, signs, or PECS, but may require echoic, imitative, or other prompts, but no physical prompts (e.g., cracker, book). (E)", "example": null, "materials": "Gather items or plan actions that function as reinforcement for the child.", "objective": "To determine if a child mands with echoic prompts. For a child using ... be necessary.", "number": 1, "text": "Emits 2 words, signs, or PECS, but may require echoic, imitative, or other prompts, but no physical prompts (e.g., cracker, book) Either testing or observation", "title": null, "responses": [ { "score": 0, "text": "Score 0 Points", "description": "" }, { "score": 0.5, "text": "Score 1\/2 Point", "description": "" }, { "score": 1, "text": "Score 1 Point", "description": "Give the child 1 point if he responds when an adult provides an ... or icon." } ] }, { "definition": "Emits 4 different mands without prompts (except, What do you want?) the desired item can be present (e.g., music, Slinky, ball). (E)", "example": "A child says or signs \u201cswing\u201d when he is on a swing and wants to be pushed, and he does so without an echoic or imitative prompt.", "materials": "Gather items or plan actions that function as reinforcement for the child.", "objective": "To determine if a child mands with echoic prompts. For a child using ... necessary.", "number": 2, "text": "Emits 4 different mands without prompts (except, What do you want?) the desired item can be present (e.g., music, Slinky, ball) Either testing or observation", "title": null, "responses": [ { "score": 0, "text": "Score 0 Points", "description": "" }, { "score": 0.5, "text": "Score 1\/2 Point", "description": "" }, { "score": 1, "text": "Score 1 Point", "description": "Give the child 1 point if he mands for 4 different reinforcers ... similar)." } ] },
...
],
"count" : 15 }