Overview
Required Headers
- Authorization: Token token="<your session token here>"
- User-Agent: rest-api
- 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 is omitted, the result will be an array containing all of the question entries for the given area and group. |
Fields
| Field | Type | Optional | Description |
|---|---|---|---|
| example | string | Optional | An example of how the question might be administered. Required when area == 'milestones' |
| materials | string | Optional | Information about what materials might be required to administer the question. Required when area == 'milestones' |
| objective | string | Optional | The objective of the question. Required when area == 'milestones' |
| 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 for Barriers & Transitions. Required when area == 'barriers', 'transitions' |
| responses | array | Required | An array of response/score definitions |
| skills | array | Optional | The Task Analysis skills associated with the milestone question. Required when area == 'milestones' |
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 |
skills Fields
| Field | Type | Optional | Description |
|---|---|---|---|
| id | string | Required | The skill identifier (e.g. '1-a') |
| skill | string | Required | A string to display that describes the skill |
| supporting | boolean | Required | true/false as to whether this is a 'supporting' skill (identified in assessment with a '*' after the skill id, e.g. '2-a*') |
Example
Example 1 - question_num provided
curl -X GET \
-H 'Authorization: Token token="9319224d0002e7a32b26c0686c42a0bf"' \
-H "User-Agent: rest-api" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-ClientId: 1" \
https://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" \
https://data-sandbox.vbmappapp.com/1/protocol/area_question?area=milestones\&group=mand
Response
Example 1
{
"response": {
"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)."
}
],"skills": [
{ "skill": "2-a","text": "Points to 2 different reinforcers in order to obtain them 2 times (E)"
},
{ "skill: "2-b","text": "Nods or says yes or no when offered a reinforcer 2 times (not an early target) (E)"
}, ...
]
} }
Example 2
{
"response": [
{ "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": "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."
}
],"skills": [
{ "skill": "2-a","text": "Points to 2 different reinforcers in order to obtain them 2 times (E)"
},
{ "skill: "2-b","text": "Nods or says yes or no when offered a reinforcer 2 times (not an early target) (E)"
}, ...
]
}
},
{
"response": [
{
"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 }