Pearson
Always Learning

Important: These Exam APIs are valid only for exams created or copied after June 1, 2012. Exams created or copied prior to this date cannot be used with these APIs.

The Exam API functionality provides the following for existing exams:

  • Retrieve exam content (for example, get exam for student to take).
  • Start an exam (for example, allow student to take it).
  • End an exam (for example, student has finished exam).
  • Reset an exam (for example, discard all exam entries and allow student to start over).

Note: These APIs require an existing exam. They do not support creation or editing of an exam. Currently, exams must be created and modified in the LearningStudio user interface.

Release Date: April 16, 2013

Affected Products: LearningStudio

Affected APIs: Exam

Release Date: June 18, 2013

Affected Products: LearningStudio

Affected APIs: Exams

Release Date: November 14, 2013

Affected Products: LearningStudio

Affected APIs: Exams

Release Date: March 13, 2014

Affected APIs: Announcements, Courses, Course Enrollment, Deeplinking, Exams, Grades, Schedules

Affected Products: LearningStudio

Creates a new exam instance or retrieves the details of an already provisioned exam instance. Also used to delete an instance (reset an exam).
/users/{userId}/courses/{courseId}/exams/{examId}

This guide outlines the API sequence for a user taking an exam for the first time or if the exam had been reset (entire exam history deleted for that user).

Create an attempt to begin saving answers and mark it as complete to submit the exam for grading.

/users/{userId}/courses/{courseId}/exams/{examId}/attempts

Developer: Bridgepoint Education Level of Effort: Advanced

This guide describes the API sequence to continue taking an exam once the exam was interrupted, for example if user stops then continues the exam or moves to another device.

Overview of how the exams handle data, create exam instances for students, and what happens behind the scenes as you use the APIs.

The exams system has more robust error handling and reporting than most other Course APIs. This document describes the most common error messages you may encounter and how to solve them.

Retrieve detailed preview information for exams in a course.

/users/{userId}/courses/{courseId}/examDetails

Retrieve and update the gradebook review dates of all of the exams within a course.

/courses/{courseId}/examschedules

The Exams API require the use of an Exam Token sent via an HTTP Header for certain operations. Optionally, teachers can also add a password to exams, which is also sent via an HTTP Header.

Use the LearningStudio Exams API to create an alternative test-taking experience for students.

Retrieve array of the user's questions within an exam section.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/questions

Retrieve the list of sections in an exam instance ID for a specific user ID. Sections contain the predefined questions and choices for the exam.

/users/{userId}/courses/{courseId}/exams/{examId}/sections

Retrieve question text for a Essay Question.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/essayquestions

Retrieve question text for a Fill-in-the-Blank Question.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/fillintheblankquestions

Retrieve answer options for a Many Multiple-Choice Question.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/manyMultipleChoiceQuestions/{quesitonId}/choices

Retrieve question text for a Many Multiple-Choice Questions.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/manyMultipleChoiceQuestions

Retrieve answer options for a Matching Question.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/matchingQuestions/{questionId}/choices

Retrieve answer premises for a Matching Question.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/matchingQuestions/{questionId}/premises

Retrieve question text for a Matching.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/matchingQuestions

Retrieve answer options for a Multiple-Choice Question.

/users/{userId}/courses/{courseId}/exams/{examId}/sections/{sectionId}/multipleChoiceQuestions/{questionId}/choices

Always Learning
Pearson