/1/protocol - GET - Index

Owned by David Hunt (Unlicensed)
Last updated: May 15, 2023
3 min read

Overview

The /1/protocol endpoint returns the structure of the guide for the requested assessment.  The protocol is divided as follows:

  • An assessment is broken down into areas: milestones, barriers, transitions, eesa.
  • Each area has groups: Mand, tact, group1, etc.
  • Each group has questions

Please note that the results of this API call are not localized and thus can be used regardless of the locale required.  Only the results of /1/protocol - GET - Query are localized.

Required Headers

KeyValueExample
User-Agent<company identifier>The exact value here is not important, but it should include something to identify your company
Acceptapplication/json
AuthorizationBearer <your token>Bearer wV1MLk5+sFzioJw/3M5r9A==
X-SystemDomain<the system domain>vbmapp

The Response

Area Fields

FieldTypeOptionalDescription
areaStringRequiredA unique identifier for the area ('milestones', 'barriers', 'transitions', 'eesa')
groupsArrayRequiredAn array of Group objects

Group Fields

FieldTypeOptionalDescription
groupStringRequiredAn identifier for the group
questionsArrayRequiredAn array of Question objects
levelsArrayOptionalAn array of String objects (milestones only) defining the levels for the group ('level1', 'level2')

Question Fields

FieldTypeOptionalDescription
questionNumIntRequiredThe number (identifier) of this question (range 1...n)
skillCountIntRequiredThe number of skills related to the question (only interesting for milestones)
levelStringOptionalA string defining the level of the question (milestones only)

Examples

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

Response

{
    "areas": [
        {
            "area": "milestones",
            "groups": [
                {
                    "group": "mand",
                    "levels": [
                        "level1",
                        "level2",
                        "level3"
                    ],
                    "questions": [
                        {
                            "questionNum": 1,
                            "skillCount": 4,
                            "level": "level1"
                        },
                        {
                            "questionNum": 2,
                            "skillCount": 5,
                            "level": "level1"
                        },
	...
    ]
}