/1/assessment

Overview

This api is used to create a new assessment for the learner

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 *****************
X-LearnerId (Required)	123	The learner Id of user for creating the assessment

Body

Key	Value
startDate	Start date of the assessment to be updated
color	Hex code of the color to be updated e.g #ffffff

Code Example

curl --location 'https://api-sandbox.vbmappapp.com/1/assessment' \
--header 'X-LearnerId: 19334' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ***********' \
--data '{
    "startDate" : "2025-04-22T05:16:09Z",
    "color" : "#537fcd"
}'

Example Response

{
    "assessments": [
        {
            "id": 1268,
            "defaultCalendar": "{\"firstWeekday\":2,\"timeZone\":{\"identifier\":\"GMT+0530\"},\"minimumDaysInFirstWeek\":4,\"locale\":{\"identifier\":\"\"},\"identifier\":\"iso8601\"}",
            "startTime": "2025-04-22 05:16:09",
            "stopTime": null,
            "color": "#537fcd",
            "isActive": 1,
            "createdAt": "2025-06-09T08:47:27.000000Z",
            "updatedAt": "2025-06-09T08:47:27.000000Z",
            "learnerId": 19357,
            "notes": null,
            "assessor": null,
            "scores": {
                "milestones": 0,
                "barriers": 0,
                "transitions": 0,
                "eesa": 0,
                "vbmapp": 0,
                "assessmentpercent": 0
            }
        }
    ]
}