Versions Compared

Key

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

Overview

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/
vbmapp
protocol/index endpoint
groupstringRequiredOne of the group strings retrieved from the /1/
vbmapp
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/

vbmapp

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.



The text 32-bit Integer
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'
objectivestring
Required
OptionalThe objective of the question
questionNumber
. Required when area == 'milestones'
number32-bit IntegerOptional

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

questionTextstringRequiredThe text that describes the question
questionTitlestringOptional
FieldTypeOptionalDescription
score

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
Info
titleresponse Fields
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



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/vbmapp/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/vbmapp/area_question?area=milestones\&group=mand

Example 1
{ "response": { "example": "A child says or signs “swing” when he is on a swing and wants to be pushed, and he does so without an echoic or imitative prompt.", "guideContent": {
Info
titleExample
Info
titleResponse
skills 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" \
https://api-sandbox.datamtd.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" \
https://api-sandbox.datmtd.com/1/protocol/area_question?area=milestones\&group=mand


Info
titleResponse
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",
        "codetext": "Mand 1-M",
      "definition": "Emits 4 different mands without prompts (except, What do you want?) the desired item can be present (e.g., music, Slinky, ball). (E)",
Nods or says yes or no when offered a reinforcer 2 times (not an early target) (E)"
	  }, ...
    ]
  }
}

Example 2
{
  "response": [
    {
      "examplesexample": "A child says or signs “swing”\u201cswing\u201d when he is on a swing and wants to be pushed, and he does so without an echoic or imitative prompt echoic or imitative prompt.",
      "materials": "Gather items or plan actions that function as reinforcement for the child.",
      "guidePageNumberobjective": 27,"To determine if a child mands with "level": 1,echoic prompts.  For a child ...  "materials": "Gather items or plan actions that function as reinforcement for the child."necessary.",
      "number": 2,
      "objectivetext": "ToEmits 4 determinedifferent ifmands awithout childprompts mands(except, withWhat echoicdo prompts.you want?) Forthe adesired ...item willcan be necessary." present (e.g., music, Slinky, ball)  Either testing "title":or "Mand - Level 1"
    },observation",
      "guidePageNumbertitle": 27null,
      "materialsresponses": "Gather items or plan actions that function as reinforcement for the child.",[
        {
    "questionNumber": 2,     "questionTextscore": "Emits0,
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", "text": "Score 0 Points",
          "questionTypedescription": "E",
        },
"responses": [       {
          "score": 0.5,
          "text": "Score 0 Points",
        "description": ""1\/2 Point",
          "description": "Give the child \u00bd point if he only emits 1 mand."
        },
        {
          "score": 0.51,
          "text": "Score 1\/2 Point",
          "description": "Give the child ½ point1 point if he emits 3 of these types of mands." ... icon."
        }
      }],
       {"skills": [
        { "scoreskill": 1,"2-a",
          "text": "ScorePoints to 12 Point",different reinforcers in order to obtain them 2 times "description": "Give the child 1 point if he mands for 4 different reinforcers without the adult ... (or something similar)."(E)"
        },
        { "skill: "2-b",
           }
    ]
  }
}
 
Example 2
{
  "response": [
    {
"text": "Nods or says yes or no when offered a reinforcer 2 times (not an early target) (E)"
	    }, ...
      "guideContent": {
 ]
  }
    },
{
  "coderesponse": [
"Mand 1-M",    {
      "definitionexample": "Emitsnull,
2 words, signs, or PECS, but may require echoic, imitative, or other prompts, but no physical prompts (e.g., cracker, book). (E)",
 "materials": "Gather items or plan actions that function as reinforcement for the child.",
      "examplesobjective": "ATo determine if a child saysmands “cookie”with whenechoic heprompts. wantsFor a cookie,child butusing he... needs an echoic prompt in order to respond. ... for action."be necessary.",
      "number": 1,
        "guidePageNumbertext": 27,"Emits 2 words, signs, or PECS, but may  "level": 1require echoic, imitative, or other prompts, but no physical prompts (e.g.,  "materials": "Gather itemscracker, book)  Either testing or planobservation",
actions that function as reinforcement for the child.",
"title": null,
       "objectiveresponses": "To[
determine if a child mands with echoic prompts. For a child using sign language or a child selecting pictures, can the child mand with imitative or pointing prompts? If early manding is weak, limited, or typically requires physical prompting, a more careful assessment of the child's exact level will be necessary.", {
          "score": 0,
          "text": "Score 0 Points",
          "description": ""
        },
 "title": "Mand - Level 1"   {
   },       "guidePageNumberscore": 27,0.5,
          "questionNumbertext": "Score 1\/2 Point",
          "questionTextdescription": ""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"score": 1,
          "questionTypetext": "E",
      "responses": [Score 1 Point",
         { "description": "Give the child 1 point if he responds when "score": 0,
    an adult provides an ... or icon."
     "text": "Score 0 Points",}
      ]
   "description": "" },
    {
   },   "definition": "Emits 4 different mands without {prompts (except, What do you want?) the desired item can be "score": 0.5,
   present (e.g., music, Slinky, ball). (E)",
      "textexample": "Score 1\/2 Point",
          "description": "Give the child \u00bd point if he only emits 1 mand."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.",
      "scoreobjective": 1,"To determine if a child mands with echoic prompts.   "text": "Score 1 Point",
   For a child using ... necessary.",
      "descriptionnumber": "Give2,
the child 1 point if ... icon."
        }
      ]
    },
    { "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",
      "exampletitle": "Anull,
child says or signs “swing” when he is on a swing and wants to be pushed, and he does so without an echoic or imitative prompt.","responses": [
        {
          "guideContentscore": 0,
{          "codetext": "Mand 1-MScore 0 Points",
          "definitiondescription": ""Emits
4 different mands without prompts (except, What do you want?)},
the desired item can be present (e.g., music, Slinky,{
ball). (E)",         "examplesscore": "A child says or signs “swing” when he is on a swing and wants to be pushed, and he does so without an echoic or imitative prompt.",
0.5,
          "text": "Score 1\/2 Point",
          "description": ""
       "guidePageNumber": 27},
        {
"level": 1,         "materialsscore": 1,
  "Gather items or plan actions that function as reinforcement for the child.","text": "Score 1 Point",
          "objectivedescription": "To determineGive the child 1 point if ahe child mands withfor echoic4 prompts.different reinforcers ... be necessarysimilar).",
        }
"title": "Mand - Level 1"  ]
    },
  ...
  ],
  "count" : 15
}