Skip to main content

Exam Config

Routes​

Get Exam Configs​

GET /api/exam/:examId/exam-configs

Returns a paginated list of exam-config records belonging to the requested exam record.

Create Exam Config​

POST /api/exam/:examId/config

Creates an exam-config for an exam. An exam-config is describes how to administer an assessment, and is the record that contains all exam-session records.

Update Exam Config​

→ Sample Request

PUT /api/exam-config/{{examConfigId}}
Content-Type: application/json
Authorization: Basic *****

{
  "config": {
    "allowRetakes": true,
    "enableReadAloud": true,
    "showCorrectAnswersOnComplete": true,
    "showScoreOnComplete": true,
    "shuffleOptions": true,
    "attemptResolutionStrategy": {
      "mode": "HIGHEST"
    }
  }
}

Get Exam Config​

GET /api/exam-config/:examConfigId

Returns details for a single exam-config record.

Get Exam Sessions​

Returns a paginated list of exam-session records belonging to the requested exam-config record.

GET /api/exam-config/:examConfigId/exam-sessions

→ Sample Request

GET /api/exam-config/:examConfigId/exam-sessions
Content-Type: application/json
Authorization: Basic *****

Create Exam Session​

Create an exam-session for a given exam-config

POST /api/exam-config/:examConfigId/exam-sessions

→ Sample Request

POST /api/exam-config/{{examConfigId}}/exam-session
Content-Type: application/json
Authorization: Basic *****

{
  "user_id": "student@examspark.com", // required
  "context_label": "GEOM", // course label
  "context_title": "Geometry", // course title
  "lis_person_name_given": "John", // first name
  "lis_person_name_family": "Deaux", // last name
  "lis_person_sourcedid": "123", // ID specifically used by a SIS
  "lis_outcome_service_url": "https://api.examspark.dev/api/exam-session/results-webook", // grade passback (webhook)
  "lis_result_sourcedid": "gradebook-cell-1", // gradebook cell to passback with grade passback
  "resource_link_id": "0" // id of exam/assessment/activity in host system
}