Skip to content

API ​

All endpoints are on the university's own address, e.g. https://<university>.<platform domain>, and need a logged-in user. Each call only returns and changes what the user's roles allow (roles).

EntityEndpoint
Annotated Answer Copy (PDF)/api/osm/annotated_copy
Answer Booklet/api/osm/answer_booklet
Answer Script (Scanned)/api/osm/answer_script
Assessment (Paper to Evaluate)/api/osm/assessment
Attendance Sheet/api/osm/attendance_sheet
Blank Barcode/api/osm/blank_barcode
Bundle/api/osm/bundle
Evaluation (Marking)/api/osm/evaluation
Evaluator Profile & Bank Details/api/osm/evaluator
Evaluator Pool (Bucket)/api/osm/evaluator_pool
Centre Inward Count/api/osm/inward_count
Paper Inward Verification/api/osm/inward_summary
Moderation Range/api/osm/moderation_range
Moderation Rule/api/osm/moderation_rule
Offline Paper Dispatch to Evaluator/api/osm/offline_dispatch
Offline (Non-OSM) Evaluation Tally/api/osm/offline_evaluation
OMR Part III (Barcode to Booklet)/api/osm/omr_booklet_link
OMR Part II (Marks Sheet)/api/osm/omr_marks_sheet
Question/api/osm/question
Question Paper Format/api/osm/question_paper_format
Question Set / Marking Scheme/api/osm/question_set
Storage Rack/api/osm/rack
Photocopy / Revaluation Request/api/osm/revaluation_request
Bundle Scan Assignment/api/osm/scan_assignment
Scanner Station/api/osm/scanner_station
Subject Equivalence/api/osm/subject_equivalence
Subject Evaluation Rule/api/osm/subject_rule

Events ​

DirectionEvent
emitsosm.answer_booklet.inwarded
emitsosm.answer_script.uploaded
emitsosm.evaluation.allocated
emitsosm.evaluation.submitted
emitsosm.evaluation.flagged
emitsosm.evaluation.finalised
emitsosm.revaluation_request.completed
emitsosm.annotated_copy.generated
listens toexam.exam_form.submitted
listens toexam.revaluation_request.submitted

Settings ​

Each university sets these from its admin screen.

SettingTypeDefaultLabel
activeExamSeasonselect"Summer"Active exam season for scanning and marking
activeExamYeartext""Active exam year/batch
defaultAllocationModeselect"Allocate"Default evaluator allocation mode
moderationEnabledchecktrueRun moderation after initial marking
revaluationRoundsnumber2Revaluation rounds allowed
sendMarksOnLockcheckfalseSend marks to Exam automatically when an evaluator locks a batch
loginOtpRequiredcheckfalseRequire a login OTP for OSM users
maxUploadFileSizeMbnumber50Maximum scan upload size (MB)
revaluationLotEmailtext""University email that receives revaluation lots
certificateSignatoryNametext""Signatory name on evaluator certificates
certificateSignatoryTitletext""Signatory title on evaluator certificates
dailyJobsEnabledchecktrueRun daily jobs (barcode generation, failed-email retry, dashboard refresh)

Edulab Bench developer documentation