/1/guide - GET
- David Hunt (Unlicensed)
Owned by David Hunt (Unlicensed)
Overview
The /1/guide endpoint returns the structure of the guide for the requested assessment. 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, contain the sections.
The resulting information is used in the remaining /1/guide and /1/protocol APIs.
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-SysemDomain | <the system domain> | vbmapp |
Optional Headers
| Key | Value | Default |
|---|---|---|
| Accept-Language | <language locale> | en |
The Response
Chapter Fields
| Field | Type | Optional | Description |
|---|---|---|---|
| title | String | Required | The title of the chapter |
| content | String | Required | The HTML content of the chapter |
| sections | Array<Section> | Required | An array of sections in the chapter |
Section Fields
| Field | Type | Optional | Description |
|---|---|---|---|
| title | String | Required | The title of the section |
| content | String | Required | The HTML content of the section |
Examples
Example
curl -X GET \
-H 'User-Agent: dmid-rest-api' \
-H 'Authorization: Bearer wV1MLk5+sFzioJw/3M5r9A==' \
-H "Accept: application/json" \
-H "Accept-Language: es" \
-H "X-SystemDomain: vbmapp" \
https://api-sandbox.datamtd.com/1/guide
Response
{
"chapters": [
{
"title": "VB- MAPP Español",
"content": "<div class=\"title_page\">\n\n <hr style=\"border-color: #923E59;\">\n\n ... </div>",
"sections": [
{
"title": "RECONOCIMIENTOS",
"content": "<div class=\"acknowledgements\">\n\n <h1 id=\"index_title\" class=\"page_banner\">RECONOCIMIENTOS</h1>\n\n <p>\n El análisis innovador análisis de B.F. Skinner sobre la conducta humana (1953) y el lenguaje (1957) ha resistido\n ...</div>\n"
},
...
]