Versions Compared

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.



info32-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. 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
FieldTypeOptionalDescription
score
skills
titleresponse Fields
arrayOptionalThe 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/protocol/area_question?area=milestones\&group=mand\&question_num=1

Example 2 - question_num omitted
Info
titleExample
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

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)",

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

Info
titleResponse

\&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)." 4 different reinforcers ... (or something similar)."
      }
    ],
    "skills": [
      { "skill": "2-a",
       }
    ]
  }
}
 
Example 2
{
  "response": [ "text": "Points to 2 different reinforcers in order to obtain them 2 times (E)"
     { },
      {  "definition"skill: "Emits 2-b",
 words, signs, or PECS, but may require echoic, imitative, "text": "Nods or othersays prompts,yes butor no physical prompts (e.g., cracker, book).when offered a reinforcer 2 times (not an early target) (E)"
	  }, ...
    ]
  }
}

Example "examples2
{
  "response": "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,
  "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 ... be necessary.",
      "number": 2,
      "titletext": "Mand - Level 1"
      }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",
      "guidePageNumbertitle": 27null,
       "questionNumberresponses": [
  1,      {
"questionText": "Emits 2 words, signs, or PECS, but may require echoic, imitative "score": 0,
or other prompts, but no physical prompts (e.g., cracker, book)  Either testing or observation","text": "Score 0 Points",
          "questionTypedescription": "E",
       "responses": [ },
        {
          "score": 0.5,
          "text": "Score 0 Points1\/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 \u00bd1 point if he only emits 1 mand." ... icon."
        }
   },   ],
      {
"skills": [
         { "scoreskill": 1"2-a",
           "text": "ScorePoints 1to Point",2 different reinforcers in order to obtain them 2 times (E)"
  "description": "Give the child 1 point if ... icon."      },
        { "skill: "2-b",
   }       ]
    },{
  "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)","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
}