PATCH - Student Assignment Sheet
The API allows clients to upload and associate documents with an existing student assignment sheet for a specific assignment. Only one type of file format (either PDF or multiple images like JPEG) is allowed for a single assignment sheet. Mixing formats in a single assignment sheet is not permitted.
Scenarios:
-
Uploading PDF Document to a Student’s assignment Sheet:
- The teacher provides the assignment Sheet ID and uploads a PDF.
- Outcome:
- The student’s scanned assignment sheet is successfully uploaded in PDF format, replacing the placeholder document.
-
Uploading Multiple JPEG Images for a Student’s assignment Sheet:
- A student’s handwritten assignment sheet is scanned in parts and saved as multiple JPEG images.
- The teacher uploads each image sequentially using the same assignment Sheet ID.
- Outcome:
- All images are uploaded, completing the student’s assignment 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.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier of the assignment
Unique identifier of the answer sheet
Body
Numeric type representing the role of the user.
"1"
List of answer sheet documents to upload (if any).
Flag to trigger evaluation if set to 'true'. Only one of documents, or isFinal is allowed.
true
Response
Unique identifier for the answer sheet.
"57387c68-0706-4a9d-834a-237b6b63cb5d"
Status of the answer sheet (refer this doc to get the constants)
0
Unique identifier of the student.
"12345"
Name of the student.
"John Doe"
Unique identifier of the batch.
"batch_1"
Unique identifier of the session.
"session_1"
List of documents associated with the assignment.