/1/protocol/index - GET

Overview

The /1/protocol/index endpoint returns the structure of the VB-Mapp assessment. An assessment is divided as follows:

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

The response to this endpoint contains a list of areas, each of which in-turn contains the groups and each group contains the number of questions in that group.

This information is used to query the remaining /1/vbmapp/... APIs.

Required Headers

Authorization: Token token="<your session token here>"
Content-Type: application/json
X-ClientId: <the client id here> or X-ClientCode: <the client code here>

Area Fields

Field	Type	Optional	Description
area	string	Required	A unique identifier for the area ('milestones', 'barriers', 'transitions', 'eesa', 'taskanalysis')
groups	array	Required	An array of group objects

Group Fields

Field	Type	Optional	Description
group	string	Required	An identifier for the group
question_count	32-bit Integer	Required	The number of questions in the group
levels	array	Optional	An array of level objects

Level Fields

Levels are a sub-grouping of the group's questions. The information provided by 'Level Fields' is simply an alternate way to group the questions. This sub-grouping is only used by the 'milestones' and 'taskanalysis' areas (i.e. 'Level 1', 'Level 2', 'Level 3').

Field	Type	Optional	Description
level	string	Required	An identifier for the level
start_question_num	32-bit Integer	Required	The question_num (0..Group.question_count-1) in the group's questions that begins the level
question_count	32-bit Integer	Required	The number of questions in the level
sub_question_counts	array	Optional	The number of sub questions for each question. Required when area == TaskAnalysis

Example

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/index

Response

{
  "response": [
    {
      "area": "milestones",
      "groups": [
        {
          "group": "mand",
          "question_count": 15,
          "levels": [
            {
              "level": "level1",
              "start_question_num": 0,
              "question_count": 5
            },
            {
              "level": "level2",
              "start_question_num": 5,
              "question_count": 5
            },
            {
              "level": "level3",
              "start_question_num": 10,
              "question_count": 5
            }
          ]
        },
        {
          "group": "tact",
          "question_count": 15,
          "levels": [
            {
              "level": "level1",
              "start_question_num": 0,
              "question_count": 5
            },
            {
              "level": "level2",
              "start_question_num": 5,
              "question_count": 5
            },
            {
              "level": "level3",
              "start_question_num": 10,
              "question_count": 5
            }
          ]
        },

...
  ],
  "count": 4
}