Versions Compared

Old Version 14

changes.mady.by.user Steve Maher

Saved on

compared with

New Version 15

changes.mady.by.user David Hunt

Saved on

Key

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

...

Info
titleRequired 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>


Info
titleArea Fields


FieldTypeOptionalDescription
areastringRequiredA unique identifier for the area ('milestones', 'barriers', 'transitions', 'eesa')
groupsarrayRequiredAn array of group objects



Info
titleGroup Fields


FieldTypeOptionalDescription
groupstringRequiredAn identifier for the group
question_count32-bit IntegerRequiredThe number of questions in the group
levelsarrayOptionalAn array of level objects



Info
titleLevel 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' areas (i.e. 'Level 1', 'Level 2', 'Level 3').

FieldTypeOptionalDescription
levelstringRequiredAn identifier for the level
start_question_num32-bit IntegerRequiredThe question_num (0..Group.question_count-1) in the group's questions that begins the level
question_count32-bit IntegerRequiredThe number of questions in the level
skill_countsarray of 32-bit IntegerOptionalThe number of Task Analysis skills for each Milestone question. Required when area == 'milestones'



Info
titleExample

curl -X GET \
-H 'Authorization: Token token="9319224d0002e7a32b26c0686c42a0bf"' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-ClientId: 1" \
httphttps://data-sandbox.vbmappapp.com/1/protocol/index

...

Info
titleResponse
{
  "response": [
    {
      "area": "milestones",
      "groups": [
        {
          "group": "mand",
          "question_count": 15,
          "levels": [
            {
              "level": "level1",
              "start_question_num": 0,
              "question_count": 5,
              "skill_counts": [4, 5, 4, 5, 5]
            },
            {
              "level": "level2",
              "start_question_num": 5,
              "question_count": 5
              "skill_counts": [5, 7, 6, 6, 6]
            },
            {
              "level": "level3",
              "start_question_num": 10,
              "question_count": 5,
              "skill_counts": [5, 5, 6, 4, 5]
            }
          ]
        },
        {
          "group": "tact",
          "question_count": 15,
          "levels": [
            {
              "level": "level1",
              "start_question_num": 0,
              "question_count": 5,
              "skill_counts": [1, 0, 2, 2, 3]
            },
            {
              "level": "level2",
              "start_question_num": 5,
              "question_count": 5,
              "skill_counts": [4, 5, 4, 5, 5]
            },
            {
              "level": "level3",
              "start_question_num": 10,
              "question_count": 5,
              "skill_counts": [9, 7, 6, 5, 7]
            }
          ]
        },
...
  ],
  "count": 4
}

 

...