/1/assessment - PATCH

Owned by David Hunt (Unlicensed)
Last updated: Dec 20, 2023
1 min read

Overview

The /1/assessment - PATCH endpoint provides for the ability to update an assessment for a given learner.

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
AuthorizationBearer <your token>Bearer wV1MLk5+sFzioJw/3M5r9A==
Content-Typeapplication/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)

Required Query Parameters

Key
Value
Example
assessmentIdIntThe assessment id to update (from /1/assessment - GET)

Fields

FieldTypeOptionalDescription
startDateISO 8601 DateOptionalThe date and time at which the assessment was started
colorStringOptionalAn HTML/CSS color string that will be the color for the assessment (as used in the grids, for example)

Modifying Start Date

Assessments are ordered by startDate.  Therefore, great care must be taken when modifying the startDate as doing so will potentially modify the order of the assessments.  This can affect scoring, especially in VB-MAPP as scoring and grids are based on the order of the assessments.


Example


Example

curl -X PATCH \
  -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" }' \
  https://api-sandbox.datamtd.com/1/assessment?assessmentId=42