AlmondTill/G3N API

On this page

startTrainingAttempt

mutation · in the family Your own session

What it does

Start your own sitting of a course’s test — the platform draws the questions and keeps exactly that draw.

Start YOUR OWN sitting of a course's test: the platform draws 10 ACTIVE questions of the course (every active question when fewer; below 3 refuses CONFLICT/TRAINING_TOO_FEW_QUESTIONS) and stores EXACTLY that draw on the record; passMark = the strictest active requirement binding your roles for the course, else 80. ONE open sitting per course (CONFLICT/TRAINING_ATTEMPT_OPEN names the holder); at most 5 sittings per course per UTC day (CONFLICT/TRAINING_CAP). courseKey must be a live play key (VALIDATION otherwise). Requires the unrestricted capability on a USER session.

What happens

Creates your sitting; one per course open at a time, at most five a day.

Who may call it

Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.

Arguments

NameTypeRequiredNotes
courseKeyString String!yesNo further notes.

Returns

TrainingAttempt TrainingAttempt! — A TrainingAttempt (🎓 — THE TRAINING PROGRAM, THE WIRE): ONE sitting of a course's test by ONE person — ALWAYS the caller who started it (nobody starts one for someone else). At start the platform draws 10 ACTIVE questions of the course (every active question when fewer; below 3 the start refuses CONFLICT/TRAINING_TOO_FEW_QUESTIONS) and stores EXACTLY that draw (questionIds); passMark is copied from the strictest requirement binding the person for the course, else the default; curriculumVersion is the play's content hash at the sitting. At submit the answers are GRADED SERVER-SIDE against the STORED draw (a later bank edit never re-grades it) — score 0..100, passed = score >= passMark; a PASS mints the TrainingCertificate in the SAME transaction (certificateId). open (live) → submitted (terminal, kept) by the subject · open → doomed (terminal) by manage authority. ONE open sitting per (person, course) — a second start refuses CONFLICT/TRAINING_ATTEMPT_OPEN; at most 5 sittings per (person, course) per UTC day (CONFLICT/TRAINING_CAP). The by-id read answers the subject or the training-manage right; the listing is the manage right's. NOT searchable.

Example request

mutation ExampleStartTrainingAttempt($courseKey: String!) {
  startTrainingAttempt(courseKey: $courseKey) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    userId
    orgId
    courseKey
    questionIds
    answers
    score
    passed
    passMark
    startedAt
    submittedAt
    curriculumVersion
    certificateId
  }
}

Variables:

{
  "courseKey": "<course key>"
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "startTrainingAttempt": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TT-EXMP-0000-000F",
      "type": "TrainingAttempt",
      "caption": "Blue jeans",
      "status": "open",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "userId": "01900000-0000-7000-8000-11f967df0000",
      "orgId": "01900000-0000-7000-8000-b0cf4f3c0000",
      "courseKey": "<course key>",
      "questionIds": [
        "01900000-0000-7000-8000-e1e983890000"
      ],
      "answers": [
        1
      ],
      "score": 1,
      "passed": true,
      "passMark": 1,
      "startedAt": "2027-01-31T00:00:00.000Z",
      "submittedAt": "2027-01-31T00:00:00.000Z",
      "curriculumVersion": "<curriculum version>",
      "certificateId": "01900000-0000-7000-8000-b335ac0d0000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer