/1/assessment - GET
- Steve Maher
- David Hunt (Unlicensed)
Owned by Steve Maher
Overview
The /1/assessments endpoint provides for the ability to retrieve assessment data for a given learner.
Description
In order to use the iFrame API, a temporary token must be used to authenticate the call. This token is obtained by calling this API with the headers as described below. The resulting token is valid for 24 hours, after which a new token must be obtained. It is okay to obtain a new token before the 24 hour period has expired; the new token will invalidate any previously obtained token.
Beta API
NOTE: This API is currently in beta and applies only to the 'iFrame' API customers.
Endpoint Details
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== |
| Content-Type | application/json | |
| X-SystemDomain | <the system domain> | vbmapp |
| X-UserId | <the user id> | The id of the user to view the learners for (See REST API Guide and /1/user - POST) |
| X-UserCode | <the user code> | The code of the user to view the learners for (See REST API Guide and /1/user - POST) |
| X-LearnerId | <the learner id> | The DMTD-supplied identifier that identifies the learner (see REST API Guide) |
| X-LearnerCode | <the learner code> | A REST-client-supplied identifier that identifies the learner (see REST API Guide) |
Optional Headers
| Key | Value | Default | Description |
|---|---|---|---|
| Accept-Language | <language locale> | en | The language in which to generate the reports (default will be English) |
Query Parameters
Key | Type | Required | Description | Example |
|---|---|---|---|---|
| scores | Boolean | Optional | Indicates that assessment scores should be provided (default = false) | scores=true |
| grids | Boolean | Optional | Indicates that the grids should be provided for each assessment (default = false) | grids=true |
| grid_scores | Boolean | Optional | Indicates that the grid scores should be provided for each assessment (default = false) | grid_scores=true |
| iep | Boolean | Optional | Indicates that the IEP report should be provided for the learner (default=false) | iep=true |
The Response
Response Fields
Field | Type | Optional | Description |
|---|---|---|---|
| vbmapp | VB-MAPP | Optional | The VB-MAPP object |
VB-MAPP Fields
Field | Type | Optional | Description |
|---|---|---|---|
| assessments | Array | Optional | An array of VB-MAPP Assessment objects |
| iep | Base 64-Encoded String | Optional | A MS Word document encoded as a Base-64 string containing the IEP report for the learner |
| grids | VB-MAPP Grids Object | Optional | A VB-MAPP Grids object |
| gridScores | VB-MAPP Grids Scores Object | Optional | A VB-MAPP Grids Scores object |
VB-MAPP Assessment Fields
Field | Type | Optional | Description |
|---|---|---|---|
| id | Int | Required | A unique identifier for the VB-MAPP Assessment |
| startDate | ISO 8601 Date | Required | The date and time at which the assessment was started |
| color | String | Optional | The color associated with the assessment, if it was specified |
| scores | Array | Optional | An array of VB-MAPP Score objects |
| assessor | String | Optional | The primary user that conducted the assessment |
VB-MAPP Score Fields
Field | Type | Optional | Description | |
|---|---|---|---|---|
| timestamp | ISO 8601 Date | Required | The date and time at which the score was recorded | |
| area | String | Required | The area of the question | An area provided by /1/protocol - GET - Index |
| group | String | Optional | The group of the question | A group provided by /1/protocol - GET - Index |
| questionNum | Int | Optional | questionNum=1 | A level provided by /1/protocol - GET - Index |
| score | Double | Required | The score's value |
VB-MAPP Grids Fields
Field | Type | Optional | Description |
|---|---|---|---|
| milestones | Array of Base-64 Encoded String | Optional | An array of PDF documents encoded as a Base-64 string containing the report |
| barriers | Array of Base-64 Encoded String | Optional | An array of PDF documents encoded as a Base-64 string containing the report |
| transitions | Array of Base-64 Encoded String | Optional | An array of PDF documents encoded as a Base-64 string containing the report |
| taskAnalysis | Array of Base-64 Encoded String | Optional | An array of PDF documents encoded as a Base-64 string containing the report |
VB-MAPP Grids Scores Fields
Field | Type | Optional | Description |
|---|---|---|---|
| milestones | Array of VB-MAPP Milestone Grid Score Object | Optional | An array of VB-MAPP Milestone Grid Score objects |
| barriers | Array of VB-MAPP Barriers/Transitions Score Object | Optional | An array of VB-MAPP Barriers/Transitions Grid Score objects |
| transitions | Array of VB-MAPP Barriers/Transitions Score Object | Optional | An array of VB-MAPP Barriers/Transitions Grid Score objects |
| taskAnalysis | Array of VB-MAPP Task Analysis Score Object | Optional | An array of VB-MAPP Task Analysis Grid Score objects |
VB-MAPP Grid Header Fields
Field | Type | Optional | Description |
|---|---|---|---|
| learnerName | String | Required | The learner's full name |
| dateOfBirth | String | Required | The learner's date of birth |
| assessments | Array of VB-MAPP Grid Header Assessment Object | Required | An array of VB-MAPP Grid Header Assessment objects |
VB-MAPP Grid Header Assessment Fields
Field | Type | Optional | Description |
|---|---|---|---|
| ageAtTesting | Integer | Optional | The learner's age when the assessment began |
| key | String | Required | The value for the 'key' header field |
| totalScore | Double | Optional | The total score achieved for the assessment |
| assessmentDate | String | Optional | The date that the assessment began |
| assessmentColor | String | Optional | The HTML color string that the user chose for the assessment's color |
| tester | String | Optional | The name of the person that administered the assessment |
Milestones - Example Grid
VB-MAPP Milestone Grid Score Fields
Field | Type | Optional | Description |
|---|---|---|---|
| header | VB-MAPP Grid Header Object | Required | A VB-MAPP Grid Header object |
| levels | Array of VB-MAPP Milestone Level Object | Required | An array of VB-MAPP Milestone Level objects |
VB-MAPP Milestone Level Fields
Field | Type | Optional | Description |
|---|---|---|---|
| level | Int | Required | The level number (1...3) |
| levelTitle | String | Required | The display of the level |
| gridColumns | Array of VB-MAPP Milestone Grid Column Object | Required | An array of VB-MAPP Milestone Level Column objects |
VB-MAPP Milestone Grid Column Fields
Field | Type | Optional | Description |
|---|---|---|---|
| groupTitle | String | Required | The level number (1...3) |
| assessmentScoredZero | Array of Bool | Required | true/false as to whether each assessment's score was scored a 0 value (fill in the circle if this is true) |
| cells | Array of VB-MAPP Milestone Grid Cell Object | Required | An array of VB-MAPP Milestone Grid Cell objects (there will be 10 cells per column) |
VB-MAPP Milestone Grid Cell Fields
Field | Type | Optional | Description |
|---|---|---|---|
| cellNum | Int | Required | The number of the cell |
| borderColor | String | Optional | The HTML color string of the cell's border |
| fillColor | String | Optional | The HTML color string of the cell's fill |
Barriers/Transitions - Example Grids
VB-MAPP Barriers/Transitions Grid Score Fields
Field | Type | Optional | Description |
|---|---|---|---|
| header | VB-MAPP Grid Header Object | Required | A VB-MAPP Grid Header object |
| rows | Array of VB-MAPP Barriers/Transitions Row Object | Required | An array of VB-MAPP Barriers/Transitions Row objects |
VB-MAPP Barriers/Transitions Row Fields
Field | Type | Optional | Description |
|---|---|---|---|
| gridCells | Array of VB-MAPP Barriers/Transitions Grid Cell Object | Required | An array of VB-MAPP Barriers/Transitions Grid Cell objects |
VB-MAPP Barriers/Transitions Grid Cell Fields
Field | Type | Optional | Description |
|---|---|---|---|
| cellTitle | String | Required | The title of the grid cell |
| columns | Array of VB-MAPP Barriers/Transitions Grid Cell Column Object | Required | An array of VB-MAPP Barriers/Transitions Grid Cell Column objects |
VB-MAPP Barriers/Transitions Grid Cell Column Fields
Field | Type | Optional | Description |
|---|---|---|---|
| score | Int | Optional | The score to represent in the column |
| fillColor | String | Optional | The HTML color string to fill the 'score' number of rows in the column |
Task Analysis - Example Grid
VB-MAPP VB-MAPP Task Analysis Grid Score Fields
Field | Type | Optional | Description |
|---|---|---|---|
| gridLevels | Array of VB-MAPP Task Analysis Grid Level Object | Required | An array of VB-MAPP Task Analysis Grid Level objects |
VB-MAPP VB-MAPP Task Analysis Grid Level Fields
Field | Type | Optional | Description |
|---|---|---|---|
| header | VB-MAPP Grid Header Object | Required | A VB-MAPP Grid Header object |
| columns | Array of VB-MAPP Task Analysis Column Object | Required | An array of VB-MAPP Task Analysis Column objects |
VB-MAPP VB-MAPP Task Analysis Column Fields
Field | Type | Optional | Description |
|---|---|---|---|
| columnTitle | String | Required | The title to display for the column |
| scoreGroups | Array of VB-MAPP Task Analysis Score Group Object | Required | An array of VB-MAPP Task Analysis Score Group objects |
VB-MAPP VB-MAPP Task Analysis Score Group Fields
Field | Type | Optional | Description |
|---|---|---|---|
| scores | Array of VB-MAPP Task Analysis Score Object | Required | An array of VB-MAPP Task Analysis Score objects |
VB-MAPP VB-MAPP Task Analysis Score Fields
Field | Type | Optional | Description |
|---|---|---|---|
| scoreId | String | Required | The text to display in the score cell |
| scoreColor | String | Optional | The HTML color string to fill the score cell |
Example
Example
curl -X GET \
-H 'User-Agent: dmtd-rest-api' \
-H 'Authorization: Bearer wV1MLk5+sFzioJw/3M5r9A==' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-SystemDomain: vbmapp" \
-H "X-UserId: 2" \
-H "X-LearnerId: 42" \
https://api-sandbox.datamtd.com/1/assessment?scores=true&grids=true&grids_scores=true&iep=true