SSID's functionality can be extended to coursemology with the relevant API end points. This involves external stakeholders such as Professor Ben Leong and the Coursemology team.

Masterplan (04/09/2023 SSID-Coursemology meeting)

Coursemology integration to be split into multiple phases:
Phase 1) Develop API interface for current existing SSID web interface
Stage 1) Finalising API interface specification
Personnel in charge:
@sibinhho99

Requirements:
POST API key to be submitted in header.
POST API body to include field for submissions: zip file that contains all submitted files and template data (structure to be confirmed)
POST API body to include field for references: zip file that contains all past course files.
POST API body to include optional parameters: detection threshold, n-gram size etc
Document POST API responses:
Response for Error states (500 Generic Error, 503 Service Unavailable (When SSID is in maintenance mode), etc)
GET API key to be submitted in header.
GET API response body documentation.
Document GET API responses and body
Common API specification sheet to be created and shared between SSID and Coursemology team. (Google Doc?)
Delivery date: 10/09/2023

Stage 2) Developing API interface
Requirements:
No functional change on core SSID processing engine
API key to be produced and verified by the server.
API body to include field for submissions: zip file that contains all submitted files and template data (structure to be confirmed by si binh)
API body to include field for references: zip file that contains all past course files. These files will not need to be cross referenced with each other.
API body to include optional parameters: detection threshold, n-gram size etc
Verify that this API is working with automated tests (rspec)
Estimated Delivery date: 24/09/2023
Future planned stages:
Phase 2) Working with references zip file -> Require core plagiarism engine changes
Phase 3) Stateful APIs -> Allow SSID to store previous submissions of references and compare against previous iterations.