/1/datapull - GET
- Animesh Kumar
Overview
The /1/datapull endpoint provides for the ability to retrieve all learners with assessment of the user.
Required Headers
| Key | Value | Example |
|---|---|---|
| X-UserId | <the user id> | The id of the user to view the learners NOTE: This value must be provided by iFrame customers and only one of X-UserId or X-UserCode should be specified. All other customers must omit this header field. |
X-UserCode | <the user code> | The code of the user to view the learners NOTE: This value must be provided by iFrame customers and only one of X-UserId or X-UserCode should be specified. All other customers must omit this header field. |
X-SystemDomain | <the system domain> | vbmapp |
XUser-Agent | <company identifier> | The exact value here is not important, but it should include something to identify your company |
| Authorization | <Bearer-Token> |
|---|
Content-Type | application/json |
|---|
Accept | application/json |
|---|
Optional Headers
| Key | Value | Default |
|---|---|---|
<Your Email> |
The Response
Response
You will receive the JSON response in your e-mail.
Examples
Example
curl --location 'https://api-sandbox.datamtd.com/1/datapull?scores=true&grids=false&iep=false&grid_scores=false' \
--header 'X-UserId: 93' \
--header 'Accept: application/json' \
--header 'userAgent: dmtd-iframe' \
--header 'Content-Type: application/json' \
--header 'X-UserCode: d7c5e85f-43c5-481f-9731-0c6c829b134d' \
--header 'email: info@datamtd.com' \
--header 'X-SystemDomain: vbmapp' \
--header 'Authorization: Bearer /ULL9dpHHaDS1kaB6W6IMw=='
Data
{
"isActive": 1,
"vbmapp": {
"assessments": [
{
"id": 361,
"scores": [],
"startDate": 713699470
},
{
"id": 594,
"scores": [],
"startDate": 723553724
},
{
"id": 595,
"scores": [],
"startDate": 723554023
},
{
"id": 596,
"scores": [],
"startDate": 723554491
},
{
"id": 597,
"scores": [],
"startDate": 723554915
},
{
"id": 598,
"scores": [],
"startDate": 723555447
},
{
"id": 599,
"scores": [],
"startDate": 723556420
},
{
"id": 600,
"scores": [],
"startDate": 723556681
},
{
"id": 601,
"scores": [],
"startDate": 723557409
},
{
"id": 602,
"scores": [],
"startDate": 723558286
},
{
"id": 603,
"scores": [],
"startDate": 723559359
},
{
"id": 604,
"scores": [],
"startDate": 723575351
},
{
"id": 605,
"scores": [],
"startDate": 723576145
},
{
"id": 606,
"scores": [],
"startDate": 723576258
},
{
"id": 607,
"scores": [],
"startDate": 723576591
},
{
"id": 608,
"scores": [],
"startDate": 723576895
}
]
},
"dateOfBirth": 410227200,
"id": 3367,
"lastName": "value",
"parent": "",
"firstName": "Fred",
"color": "#ffff",
"code": "Code: MPM-1234",
"gender": 1
},
{
"isActive": 1,
"vbmapp": {
"assessments": [
{
"startDate": 719217212,
"scores": [],
"id": 381
}
]
},
"dateOfBirth": 410227200,
"id": 3368,
"lastName": "value",
"parent": "",
"firstName": "Fred",
"color": "#ffff",
"code": "Code: 1234",
"gender": 1
},
{
"isActive": 1,
"vbmapp": {
"assessments": [
{
"startDate": 713700480,
"id": 362,
"scores": []
}
]
},
"dateOfBirth": 410227200,
"id": 3369,
"lastName": "PM",
"parent": "",
"firstName": "Measure",
"color": "#ffffff",
"code": "Code: MPM-444",
"gender": 1
}
]