Overview

The /1/assessment - POST endpoint provides for the ability to create a new assessment for a given learner.

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
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)

Fields

Field	Type	Optional	Description
startDate	ISO 8601 Date	Optional	The date and time at which the assessment was started
color	String	Optional	An HTML/CSS color string that will be the color for the assessment (as used in the grids, for example)

Example

curl -X POST \
  -H 'User-Agent: dmtd-rest-api' \
  -H 'Authorization: Bearer wV1MLk5+sFzioJw/3M5r9A==' \
  -H "X-SystemDomain: vbmapp" \
  -H "X-LearnerId: 42" \
  -d '{ "startDate": "2023-06-19T05:16:09Z", "color": "#ffff" }' \
  https://api-sandbox.datamtd.com/1/assessment

Response

{

    "id": 414243, 
    "color": "#ffff",
    "startDate": "2023-06-19T05:16:09Z",
    "learnerId": 42
}