/1/assessment - GET
Overview
This api returns all the assessments for a given learner. We pass the learnerid and userid in headers and it returns the assessments data for that learner which contains different things like scores,grids,iep etc
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 which you want to fetch the assessments data for |
X-UserId (Optional) | 123 | The id of user to which this learner belongs, if left empty it will authenticate the learner against the Bearer Token. |
Params
Key | Value | Description |
---|---|---|
scores (optional) | true | fetch assessment scores in the API response |
grids (optional) | true | fetch grids in the API response |
grids_scores (optional) | true | fetch grids in the API response |
iep (optional) | true | fetch IEP in the API response |
Code Example
curl --location 'https://api-sandbox.vbmappapp.com/1/assessment?scores=true&grids=true&grids_scores=true&iep=true' \
--header 'X-LearnerId: 19353' \
--header 'X-UserId: 320' \
--header 'Authorization: Bearer ***********'
Example Response
{
"vbmapp": {
"assessments": [
{
"id": 1264,
"assessor": "user2 rese",
"startDate": "2025-04-24T01:16:09Z",
"color": "#537fcd",
"scores": [
{
"score": 1,
"timestamp": "2025-06-02T06:20:44Z",
"area": "mand",
"group": "milestones",
"questionNum": 1
},
{
"score": 1,
"timestamp": "2025-06-02T06:20:47Z",
"area": "transitions",
"questionNum": 1
},
{
"score": 0.5,
"timestamp": "2025-06-02T06:20:47Z",
"area": "mand",
"group": "milestones",
"questionNum": 2
},
{
"score": 2,
"timestamp": "2025-06-02T06:49:46Z",
"area": "barriers",
"questionNum": 1
},
{
"score": 5,
"timestamp": "2025-06-02T08:45:59Z",
"area": "transitions",
"questionNum": 2
},
{
"score": -1,
"timestamp": "2025-06-02T06:49:46Z",
"area": "transitions",
"questionNum": 3
},
{
"score": 3,
"timestamp": "2025-06-02T06:49:48Z",
"area": "barriers",
"questionNum": 3
},
{
"score": 1,
"timestamp": "2025-06-02T08:45:59Z",
"area": "barriers",
"questionNum": 5
}
]
},
{
"id": 1265,
"assessor": "user2 rese",
"startDate": "2025-06-02T04:54:30Z",
"color": "#f7d41c",
"scores": [
{
"score": 1,
"timestamp": "2025-06-02T08:54:35Z",
"area": "mand",
"group": "milestones",
"questionNum": 1
},
{
"score": 1,
"timestamp": "2025-06-02T08:54:35Z",
"area": "transitions",
"questionNum": 1
},
{
"score": 1,
"timestamp": "2025-06-02T08:54:35Z",
"area": "mand",
"group": "milestones",
"questionNum": 2
},
{
"score": 1,
"timestamp": "2025-06-02T08:54:35Z",
"area": "mand",
"group": "milestones",
"questionNum": 3
},
{
"score": 1,
"timestamp": "2025-06-02T08:54:35Z",
"area": "mand",
"group": "milestones",
"questionNum": 4
},
{
"score": 1,
"timestamp": "2025-06-02T08:54:35Z",
"area": "mand",
"group": "milestones",
"questionNum": 5
}
]
}
]
}
}
Updated about 1 month ago