LearningRecordSubmissionForm

A request or response body; the type column links to the schemas it refers to.

LearningRecordSubmissionForm

FieldTypeRequiredDescription
recordstringyes

JSON-encoded record, in the shape of the CreateLearningRecordRequest schema. Callers without records:write over the owner must use status "pending" and omit learner_user_id (the record is about themselves).

at least 1 character

evidencestringyes

JSON-encoded array of evidence, each entry in the shape of the CreateSupportingEvidenceRequest schema (without pathname — a file travels in the file part instead). At most one entry may be of evidence_type file.

at least 1 character

filestring (binary)no

The bytes of the one file evidence entry, sent as a file part. Required exactly when the evidence array contains a file entry; the part's size and content type must match what that entry's payload declares.

jsonExample
{
  "record": "{\"owner_organization_id\":\"1b671a64-40d5-491e-99b0-da01ff1f3341\",\"title\":\"Simulator session\",\"status\":\"pending\",\"completed_at\":\"2026-01-01T00:00:00.000Z\",\"subject_matter_ids\":[\"6b3f7a52-8a20-4f0e-9be1-0f6cbd2f2f5c\"]}",
  "evidence": "[{\"label\":\"Session length\",\"payload\":{\"evidence_type\":\"quantity\",\"value\":2.5,\"unit\":\"hours\"}}]",
  "file": "string"
}