A submission can be exported alongside similarity data, grades, coversheets, information on participant groups and allocations, and other details that combined can be used to analyse participant behaviour.
It is possible to export a PDF containing the submission, or it is possible to export raw FLOWmulti submission data for more comprehensive data.
Detailed Submission Data
The GET /flow/{flowId}/submissions endpoint provides an overview of who handed in, including the submission ID, the hand in status and the similarity report percentage. Using the flowId as a parameter to identify the flow, the response will return an array with all available submission data on the flow. The list will be appended with new data once these have been submitted.
[
{
"id": 1,
"status": {
"handedIn": true,
"handedInBlank": false,
"handedInDate": "2024-09-01T22:45:36.000Z",
"handedInIp": "192.158.1.38"
},
"similarityReports": [
{
"id": 2,
"percentage": 10,
"status": "status",
"provider": "provider"
}
]
}
]
The overview provided can be used to identify the number of participants who have handed in, or to pin submissions with a high similarity score.
If you need more information on a specific submission, you can use the GET /flow/{flowId}/submissions/{submissionId} endpoint. This endpoint takes a flowId and a submissionId (the ID from the above example) as parameters. This endpoint returns detailed information on a submission, including hand in status, similarity report percentage, cover sheets, participant groups, and assessor allocations.
Response model:
{
"id": 1,
"status": {
"handedIn": true,
"handedInBlank": false,
"handedInDate": "2024-09-01T22:45:36.000Z",
"handedInIp": "192.158.1.38"
},
"coverSheet": [
{
"elementId": 7,
"value": "value"
},
{
"elementId": 8,
"value": "value"
}
],
"similarityReports": [
{
"id": 2,
"percentage": 10,
"status": "status",
"provider": "provider",
"handedInDate": "2024-09-01T22:45:36.000Z"
}
],
"allocations": {
"assessors": [
{
"id": 9,
"userId": 3
},
{
"id": 10,
"userId": 4
}
],
"assessorGroupIds": [
1,
1
]
},
"participants": [
{
"id": 4,
"userId": 5,
"finalGrade": {
"grade": 10,
"date": "2024-09-01T22:45:36.000Z"
},
"alternativeGrade": {
"grade": "Sick",
"date": "2024-08-21T22:45:36.000Z"
}
}
]
}
Details on submissions within a given timeframe can be looked up on licence level using GET /license/submissions. This takes a start- and end date, and a flow purpose as parameters, and will return an array will all submissions that matches the parameters:
[
{
"handedInDate": 1,
"handedInBlank": true,
"id": 0,
"flowId": 6
}
]
The response returns the most basic information, but has both a flow ID and the submission ID used to look up further details on the submission.
When a participant has been assessed, you can fetch the assessments using the GET /flow/{flowId}/assessments endpoint. Using the flowId as a parameter to identify the flow, the response will return data with all assessed participants on the flow. The list will be appended with new assessments once they have been finalised in WISEflow.
[
{
"id": 145478,
"participantId": 4544,
"grade": "10",
"adminGrade": "",
"date": 1624607229,
"exportState": 2,
"exportDate": 1624607229,
"exportMessage": ""
}
]
Assessments can be exported either in bulk for all participants or for a single participant:
It is also possible to export the assessment for a single participant using GET /flow/{flowId}/assessments/{participantId}. This endpoint returns the same data as above, but is using the participantId as a parameter to only fetch information for a single participant.
PDF File Export
With the flow ID and the submission ID to identify the flow and the submission, GET /flows/{flowId}/submissions/{submissionId}/files is used to export all files from a submission:
{
"success": true,
"data": [
{
"id": 1,
"type": "DOCUMENT",
"filename": "handin.pdf",
"contentType": "application/pdf",
"size": 1234567,
"link": "https://s3.europe..../handin.pdf",
"createdAt": "2019-01-24T22:45:36.000Z",
"quarantine": {
"reason": "File is infected because",
"by": "WISEFLOW",
"createdAt": "2019-01-24T22:45:36.000Z"
}
}
],
"error": null
}
The response returns information on the files, whether the file has been quarantined, and a download link to the file.Where the above endpoint returns all files, information on a single file can be exported using GET /flows/{flowId}/submissions/{submissionId}/files/{fileId}. This endpoint uses a flowId, a submissionId, and a fileId as parameters to correctly identify the file. The endpoint returns information on a single file:
{
"success": true,
"data": {
"id": 1,
"type": "DOCUMENT",
"filename": "handin.pdf",
"contentType": "application/pdf",
"size": 1234567,
"link": "https://s3.europe..../handin.pdf",
"createdAt": "2019-01-24T22:45:36.000Z"
},
"error": null
}