Overview

A second variant of the /1/protocol endpoint allows for query parameters that results in the retrieval of the content for a specific Group, Level or Question.

Locale

The locale of the returned protocol is determined by the purchase that was made for the Learner (See /1/purchase - POST).

Required Headers

Key	Value	Example
User-Agent	<company identifier>	The exact value here is not important, but it should include something to identify your company
Accept	application/json
Authorization	Bearer <your token>	Bearer wV1MLk5+sFzioJw/3M5r9A==
X-SystemDomain	<the system domain>	vbmapp
X-LearnerId	<the learner id>	The DMTD-supplied identifier that identifies the learner (see REST API Guide)
X-LearnerCode	<the learner code>	A REST-client-supplied identifier that identifies the learner (see REST API Guide)

Query Paramters

Key	Type	Required	Example	Description
area	String	Required	area=milestones	An area provided by /1/protocol - GET - Index
group	String	Required	group=mand	A group provided by /1/protocol - GET - Index
level	String	Optional	level=level1	A level provided by /1/protocol - GET - Index
questionNum	Int	Optional	questionNum=1	A level provided by /1/protocol - GET - Index

The Response

Response Fields

Field	Type	Optional	Description
area	String	Required	The area of the question
group	String	Required	The group of the question
instructions	String	Optional	Instructions for the group (Required when area == 'eesa')
title	String	Optional	Title for the group (Required when area == 'eesa')
targets	String	Optional	Targets for the group (Required when area == 'eesa')
questions	Array	Required	An array of Question objects

Question Fields

Field	Type	Optional	Description
questionNum	Int	Required	The number (identifier) of this question (range 1...n)
level	Int	Optional	The level of the question (Required when area == 'milestones')
levelTitle	String	Optional	A question displayed over each level that groups the questions in the level (Required when area == 'milestones')
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'
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 & Transition (Required when area == 'barriers', 'transitions')
responses	Array	Required	An array of Response objects
skills	Array	Optional	An array of Skill objects (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 (Required when area == 'milestones' && (score == 0.5 \|\| score == 1.0))

Skill 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

curl -X GET \

  -H 'User-Agent: dmtd-rest-api' \
  -H 'Authorization: Bearer wV1MLk5+sFzioJw/3M5r9A==' \
  -H "Accept: application/json" \
  -H "X-SystemDomain: vbmapp" \
  https://api-sandbox.datamtd.com/1/protocol?area=milestones\&group=mand

Response

{
    "group": "mand",
    "questions": [
        {
            "skills": [
                {
                    "id": "1-a*",
                    "skill": "Makes eye contact (gaze shift) as a mand for attention or other reinforcers 2 times {b}(O){/b}",
                    "supporting": true
                },
                {
                    "id": "1-b*",
                    "skill": "Moves close to a reinforcing item to indicate the presence of an MO 2 times {b}(O){/b}",
                    "supporting": true
                },
                {
                    "id": "1-c*",
                    "skill": "Pulls an adult to get access to a reinforcing item 2 times {b}(O){/b}",
                    "supporting": true
                },
                {
                    "id": "1-d*",
                    "skill": "Points or gestures towards a reinforcer in order to obtain it 2 times {b}(O){/b}",
                    "supporting": true
                }
            ],
            "materials": "Gather items or plan actions that function as reinforcement for the child.",
            "level": "level1",
            "levelTitle" : "Does the child engage in independent play behavior that is automatically reinforcing?",
            "responses": [
                {
                    "score": "0",
                    "text": "Score 0 Points"
                },
                {
                    "score": "0.5",
                    "text": "Give the child ½ point if he only emits 1 mand."
                },
...

DMTD Content Server REST API

/1/protocol - GET - Query

Overview

The Response

Example