Extract Annotations and Comments from the Marking Tool

During the marking period, assessors may use annotations and comments to provide focused feedback linked to certain parts of a submission. Annotations and comments can be used as feedback to participants when exporting a submission.

Getting Annotations 

Annotations from the marking tool can be extracted with the GET /flows/{flowId}/assessors/annotations endpoint using the flow ID as a parameter. The endpoint returns information on the flow, the annotation, and the assessor:

{
 "success":true,
 "data":[
   {
     "id":4354,
     "flowId":51928,
     "containerId":1285260,
     "assessorId":200933,
     "assessorUserId":1004010345,
     "text":"Test comment",
     "displayType":"Highlight",
     "stampType":null,
     "coordinates":"70.801,594.162,505.623,636.671",
     "page":0,
     "fileId":286239,
     "shareType":"ASSESSORS",
     "createdAt":"2024-05-13T20:28:40Z",
     "updatedAt":"2024-05-13T20:28:46Z"
    }
 ],
 "error":null,
 "pagination":{
    "limit":1000,
    "offset":0,
    "total":1
}

Getting Comments

Comments in the marking tool are split up into two categories: common comments and submission comments. Common comments being comments given to all participants the assessor is allocated to, and submission comments being comments given to a single submission.

Common comments can be extracted with the GET /flows/{flowId)/assessors/common-comments endpoint. This endpoint returns comments given by the assessor to all allocated participants, including data needed to look up additional information on the flow or the assessor:

{
 "success":true,
 "data":[
   {
     "id":46257,
     "flowId":7187934,
     "assessorId":6175210,
     "assessorUserId":4510904,
     "content":"<p>Common feedback</p>",
     "shareType":"ALL",
     "createdAt":"2024-08-07T04:35:52Z",
     "updatedAt":"2024-08-07T04:35:52Z",
     "files":[]
   }
 ],
 "error":null,
 "pagination":{
  "limit":1000,
  "offset":0,
  "total":1
 }
}

Submission comments can be extracted with GET /flow/{flowId)/assessors/submission-comments:

{
 "success": true,
 "data": [
   {
     "id": 46247,
     "flowId": 7187934,
     "containerId": 60211238,
     "assessorId": 6175210,
     "assessorUserId": 4510904,
     "content": "<p>Shared with all</p>",
     "shareType": "ALL",
     "createdAt": "2024-08-06T12:34:10Z",
     "updatedAt": "2024-08-06T12:34:10Z",
     "files": []
  },
  {
    "id": 46248,
    "flowId": 7187934,
    "containerId": 60211238,
    "assessorId": 6175210,
    "assessorUserId": 4510904,
    "content": "<p>Shared with participants</p>",
    "shareType": "PARTICIPANTS",
    "createdAt": "2024-08-06T12:34:46Z",
    "updatedAt": "2024-08-06T12:34:46Z",
    "files": []
  }
 ],
 "error": null,
 "pagination": {
  "limit": 1000,
  "offset": 0,
  "total": 2
 }
}