/1/guide/index - GET

Overview

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

Chapters
Each chapter has sections
Each section can have sub sections

The response to this endpoint contains an array of chapters, each of which in-turn contains the sections.

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

Required Headers

Authorization: Token token="<your session token here>"
User-Agent: dmtd-rest-api
Content-Type: application/json

Optional Headers

X-DocType: text or html – see Content Formatting for more information
Accept-Language: <language> – see Content Formatting for more information

Chapter Fields

Field	Type	Optional	Description
sections	Array	Required	An array of sections in the chapter
title	string	Required	This is equal to title from /1/guide/chapter - GET

Section Fields

Field	Type	Optional	Description
title	String	Required	This is equal to title from /1/guide/section - GET

Example

curl -X GET \
-H 'Authorization: Token token="9319224d0002e7a32b26c0686c42a0bf"' \
-H "Accept: application/json" \
-H "User-Agent: dmtd-rest-api" \
-H "Content-Type: application/json" \
https://api-sandbox.datamtd.com/1/guide/index

Response

{
  "response": [
    {
      "sections": [
        
      ],
      "title": "Acknowledgements"
    },
    {
      "sections": [
        {
          "title": "About the VB-MAPP"
        },
        {
          "title": "Research Using the VB-MAPP"
        },
        {
          "title": "The Importance of Assessment"
        },

...

      ],
      "title": "Task Analysis and Skills Tracking: Level 3 (30-48 Months)"
    }
  ],
  "count": 16
}

Special Considerations

We reserve the right to alter the results of this index over time as updates to the guide are incorporated. Thus, it is very important that the results of this call are not cached for an indefinite period of time.

To reduce the chatter between servers, it is acceptable to cache this information during a single week period from 6am GMT Monday to 6am GMT Saturday. Any updates to the structures will be done between 6am GMT Saturday and 6am GMT Monday.