Student Answer Sheet
PATCH - Student Answer Sheet
The API allows clients to upload and associate documents with an existing student answer sheet for a specific exam. Only one type of file format (either PDF or multiple images like JPEG) is allowed for a single answer sheet. Mixing formats in a single answer sheet is not permitted.
Scenarios:
-
Uploading PDF Document to a Student’s Answer Sheet:
- The teacher provides the Answer Sheet ID and uploads a PDF.
- Outcome:
- The student’s scanned answer sheet is successfully uploaded in PDF format, replacing the placeholder document.
-
Uploading Multiple JPEG Images for a Student’s Answer Sheet:
- A student’s handwritten answer sheet is scanned in parts and saved as multiple JPEG images.
- The teacher uploads each image sequentially using the same Answer Sheet ID.
- Outcome:
- All images are uploaded, completing the student’s answer sheet and associating them for grading.
Note:
- After setting
isFinal
totrue
, the AI extraction process begins. This process may take some time to complete. - To streamline workflows, the system supports a webhook feature. Upon successful extraction, a notification is sent to the configured webhook URL.
- Only one of
documents
orisFinal
can be processed at a time.
PATCH
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Example:
"4340132f-50fa-4877-9ffa-e9b7ee59d51f"
Example:
"f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab"
Body
multipart/form-data
The details to update for the model answer.
The body is of type object
.
Response
200
application/json
Successful response
The response is of type object
.