Create Exam
curl --request POST \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"title": "Midterm Exam 1",
"type": "Online",
"useProctorManager": true,
"requireApproval": false,
"url": "<string>",
"enableAppointmentSuggestions": true,
"configuration": {
"instructorAsProctor": [
{
"location": "<string>",
"startTime": "1970-01-01T00:00:00.000Z",
"endTime": "<string>",
"capacity": 123
}
],
"examOpenDate": "1970-01-01T00:00:00.000Z",
"examCloseDate": "1970-01-01T00:00:00.000Z",
"password": "<string>",
"duration": 123,
"attempts": 123,
"requiredSoftware": "<string>",
"studentNotes": "<string>",
"permittedBathroomBreak": true,
"permittedBathroomBreakInformation": "<string>",
"permittedBlankPaper": true,
"permittedBlankPaperInformation": "<string>",
"permittedCalculator": true,
"permittedCalculatorInformation": "<string>",
"permittedDictionary": true,
"permittedDictionaryInformation": "<string>",
"permittedEarplugs": true,
"permittedEarplugsInformation": "<string>",
"permittedFormulaSheet": true,
"permittedFormulaSheetInformation": "<string>",
"permittedNotes": true,
"permittedNotesInformation": "<string>",
"permittedOtherItems": "<string>",
"permittedTextbook": true,
"permittedTextbookInformation": "<string>",
"permittedWebsites": true,
"permittedWebsitesInformation": "<string>",
"proctorNotes": "<string>",
"proctorTypes": [
"<string>"
],
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"apiExamId": "<string>",
"modalityOptions": {},
"virtualCalculatorType": "scientific-calc"
},
"description": "Covers chapters 1-5",
"examDeliverySystemModule": "canvas",
"contactUserSid": "US1234567890abcdef1234567890abcdef",
"isLimitedScope": false,
"status": "active"
}
'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams"
payload = {
"title": "Midterm Exam 1",
"type": "Online",
"useProctorManager": True,
"requireApproval": False,
"url": "<string>",
"enableAppointmentSuggestions": True,
"configuration": {
"instructorAsProctor": [
{
"location": "<string>",
"startTime": "1970-01-01T00:00:00.000Z",
"endTime": "<string>",
"capacity": 123
}
],
"examOpenDate": "1970-01-01T00:00:00.000Z",
"examCloseDate": "1970-01-01T00:00:00.000Z",
"password": "<string>",
"duration": 123,
"attempts": 123,
"requiredSoftware": "<string>",
"studentNotes": "<string>",
"permittedBathroomBreak": True,
"permittedBathroomBreakInformation": "<string>",
"permittedBlankPaper": True,
"permittedBlankPaperInformation": "<string>",
"permittedCalculator": True,
"permittedCalculatorInformation": "<string>",
"permittedDictionary": True,
"permittedDictionaryInformation": "<string>",
"permittedEarplugs": True,
"permittedEarplugsInformation": "<string>",
"permittedFormulaSheet": True,
"permittedFormulaSheetInformation": "<string>",
"permittedNotes": True,
"permittedNotesInformation": "<string>",
"permittedOtherItems": "<string>",
"permittedTextbook": True,
"permittedTextbookInformation": "<string>",
"permittedWebsites": True,
"permittedWebsitesInformation": "<string>",
"proctorNotes": "<string>",
"proctorTypes": ["<string>"],
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"apiExamId": "<string>",
"modalityOptions": {},
"virtualCalculatorType": "scientific-calc"
},
"description": "Covers chapters 1-5",
"examDeliverySystemModule": "canvas",
"contactUserSid": "US1234567890abcdef1234567890abcdef",
"isLimitedScope": False,
"status": "active"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Midterm Exam 1',
type: 'Online',
useProctorManager: true,
requireApproval: false,
url: '<string>',
enableAppointmentSuggestions: true,
configuration: {
instructorAsProctor: [
{
location: '<string>',
startTime: '1970-01-01T00:00:00.000Z',
endTime: '<string>',
capacity: 123
}
],
examOpenDate: '1970-01-01T00:00:00.000Z',
examCloseDate: '1970-01-01T00:00:00.000Z',
password: '<string>',
duration: 123,
attempts: 123,
requiredSoftware: '<string>',
studentNotes: '<string>',
permittedBathroomBreak: true,
permittedBathroomBreakInformation: '<string>',
permittedBlankPaper: true,
permittedBlankPaperInformation: '<string>',
permittedCalculator: true,
permittedCalculatorInformation: '<string>',
permittedDictionary: true,
permittedDictionaryInformation: '<string>',
permittedEarplugs: true,
permittedEarplugsInformation: '<string>',
permittedFormulaSheet: true,
permittedFormulaSheetInformation: '<string>',
permittedNotes: true,
permittedNotesInformation: '<string>',
permittedOtherItems: '<string>',
permittedTextbook: true,
permittedTextbookInformation: '<string>',
permittedWebsites: true,
permittedWebsitesInformation: '<string>',
proctorNotes: '<string>',
proctorTypes: ['<string>'],
scheduleOpenDate: '1970-01-01T00:00:00.000Z',
scheduleCloseDate: '1970-01-01T00:00:00.000Z',
apiExamId: '<string>',
modalityOptions: {},
virtualCalculatorType: 'scientific-calc'
},
description: 'Covers chapters 1-5',
examDeliverySystemModule: 'canvas',
contactUserSid: 'US1234567890abcdef1234567890abcdef',
isLimitedScope: false,
status: 'active'
})
};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Midterm Exam 1',
'type' => 'Online',
'useProctorManager' => true,
'requireApproval' => false,
'url' => '<string>',
'enableAppointmentSuggestions' => true,
'configuration' => [
'instructorAsProctor' => [
[
'location' => '<string>',
'startTime' => '1970-01-01T00:00:00.000Z',
'endTime' => '<string>',
'capacity' => 123
]
],
'examOpenDate' => '1970-01-01T00:00:00.000Z',
'examCloseDate' => '1970-01-01T00:00:00.000Z',
'password' => '<string>',
'duration' => 123,
'attempts' => 123,
'requiredSoftware' => '<string>',
'studentNotes' => '<string>',
'permittedBathroomBreak' => true,
'permittedBathroomBreakInformation' => '<string>',
'permittedBlankPaper' => true,
'permittedBlankPaperInformation' => '<string>',
'permittedCalculator' => true,
'permittedCalculatorInformation' => '<string>',
'permittedDictionary' => true,
'permittedDictionaryInformation' => '<string>',
'permittedEarplugs' => true,
'permittedEarplugsInformation' => '<string>',
'permittedFormulaSheet' => true,
'permittedFormulaSheetInformation' => '<string>',
'permittedNotes' => true,
'permittedNotesInformation' => '<string>',
'permittedOtherItems' => '<string>',
'permittedTextbook' => true,
'permittedTextbookInformation' => '<string>',
'permittedWebsites' => true,
'permittedWebsitesInformation' => '<string>',
'proctorNotes' => '<string>',
'proctorTypes' => [
'<string>'
],
'scheduleOpenDate' => '1970-01-01T00:00:00.000Z',
'scheduleCloseDate' => '1970-01-01T00:00:00.000Z',
'apiExamId' => '<string>',
'modalityOptions' => [
],
'virtualCalculatorType' => 'scientific-calc'
],
'description' => 'Covers chapters 1-5',
'examDeliverySystemModule' => 'canvas',
'contactUserSid' => 'US1234567890abcdef1234567890abcdef',
'isLimitedScope' => false,
'status' => 'active'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams"
payload := strings.NewReader("{\n \"title\": \"Midterm Exam 1\",\n \"type\": \"Online\",\n \"useProctorManager\": true,\n \"requireApproval\": false,\n \"url\": \"<string>\",\n \"enableAppointmentSuggestions\": true,\n \"configuration\": {\n \"instructorAsProctor\": [\n {\n \"location\": \"<string>\",\n \"startTime\": \"1970-01-01T00:00:00.000Z\",\n \"endTime\": \"<string>\",\n \"capacity\": 123\n }\n ],\n \"examOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"examCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"password\": \"<string>\",\n \"duration\": 123,\n \"attempts\": 123,\n \"requiredSoftware\": \"<string>\",\n \"studentNotes\": \"<string>\",\n \"permittedBathroomBreak\": true,\n \"permittedBathroomBreakInformation\": \"<string>\",\n \"permittedBlankPaper\": true,\n \"permittedBlankPaperInformation\": \"<string>\",\n \"permittedCalculator\": true,\n \"permittedCalculatorInformation\": \"<string>\",\n \"permittedDictionary\": true,\n \"permittedDictionaryInformation\": \"<string>\",\n \"permittedEarplugs\": true,\n \"permittedEarplugsInformation\": \"<string>\",\n \"permittedFormulaSheet\": true,\n \"permittedFormulaSheetInformation\": \"<string>\",\n \"permittedNotes\": true,\n \"permittedNotesInformation\": \"<string>\",\n \"permittedOtherItems\": \"<string>\",\n \"permittedTextbook\": true,\n \"permittedTextbookInformation\": \"<string>\",\n \"permittedWebsites\": true,\n \"permittedWebsitesInformation\": \"<string>\",\n \"proctorNotes\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"apiExamId\": \"<string>\",\n \"modalityOptions\": {},\n \"virtualCalculatorType\": \"scientific-calc\"\n },\n \"description\": \"Covers chapters 1-5\",\n \"examDeliverySystemModule\": \"canvas\",\n \"contactUserSid\": \"US1234567890abcdef1234567890abcdef\",\n \"isLimitedScope\": false,\n \"status\": \"active\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Midterm Exam 1\",\n \"type\": \"Online\",\n \"useProctorManager\": true,\n \"requireApproval\": false,\n \"url\": \"<string>\",\n \"enableAppointmentSuggestions\": true,\n \"configuration\": {\n \"instructorAsProctor\": [\n {\n \"location\": \"<string>\",\n \"startTime\": \"1970-01-01T00:00:00.000Z\",\n \"endTime\": \"<string>\",\n \"capacity\": 123\n }\n ],\n \"examOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"examCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"password\": \"<string>\",\n \"duration\": 123,\n \"attempts\": 123,\n \"requiredSoftware\": \"<string>\",\n \"studentNotes\": \"<string>\",\n \"permittedBathroomBreak\": true,\n \"permittedBathroomBreakInformation\": \"<string>\",\n \"permittedBlankPaper\": true,\n \"permittedBlankPaperInformation\": \"<string>\",\n \"permittedCalculator\": true,\n \"permittedCalculatorInformation\": \"<string>\",\n \"permittedDictionary\": true,\n \"permittedDictionaryInformation\": \"<string>\",\n \"permittedEarplugs\": true,\n \"permittedEarplugsInformation\": \"<string>\",\n \"permittedFormulaSheet\": true,\n \"permittedFormulaSheetInformation\": \"<string>\",\n \"permittedNotes\": true,\n \"permittedNotesInformation\": \"<string>\",\n \"permittedOtherItems\": \"<string>\",\n \"permittedTextbook\": true,\n \"permittedTextbookInformation\": \"<string>\",\n \"permittedWebsites\": true,\n \"permittedWebsitesInformation\": \"<string>\",\n \"proctorNotes\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"apiExamId\": \"<string>\",\n \"modalityOptions\": {},\n \"virtualCalculatorType\": \"scientific-calc\"\n },\n \"description\": \"Covers chapters 1-5\",\n \"examDeliverySystemModule\": \"canvas\",\n \"contactUserSid\": \"US1234567890abcdef1234567890abcdef\",\n \"isLimitedScope\": false,\n \"status\": \"active\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Midterm Exam 1\",\n \"type\": \"Online\",\n \"useProctorManager\": true,\n \"requireApproval\": false,\n \"url\": \"<string>\",\n \"enableAppointmentSuggestions\": true,\n \"configuration\": {\n \"instructorAsProctor\": [\n {\n \"location\": \"<string>\",\n \"startTime\": \"1970-01-01T00:00:00.000Z\",\n \"endTime\": \"<string>\",\n \"capacity\": 123\n }\n ],\n \"examOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"examCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"password\": \"<string>\",\n \"duration\": 123,\n \"attempts\": 123,\n \"requiredSoftware\": \"<string>\",\n \"studentNotes\": \"<string>\",\n \"permittedBathroomBreak\": true,\n \"permittedBathroomBreakInformation\": \"<string>\",\n \"permittedBlankPaper\": true,\n \"permittedBlankPaperInformation\": \"<string>\",\n \"permittedCalculator\": true,\n \"permittedCalculatorInformation\": \"<string>\",\n \"permittedDictionary\": true,\n \"permittedDictionaryInformation\": \"<string>\",\n \"permittedEarplugs\": true,\n \"permittedEarplugsInformation\": \"<string>\",\n \"permittedFormulaSheet\": true,\n \"permittedFormulaSheetInformation\": \"<string>\",\n \"permittedNotes\": true,\n \"permittedNotesInformation\": \"<string>\",\n \"permittedOtherItems\": \"<string>\",\n \"permittedTextbook\": true,\n \"permittedTextbookInformation\": \"<string>\",\n \"permittedWebsites\": true,\n \"permittedWebsitesInformation\": \"<string>\",\n \"proctorNotes\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"apiExamId\": \"<string>\",\n \"modalityOptions\": {},\n \"virtualCalculatorType\": \"scientific-calc\"\n },\n \"description\": \"Covers chapters 1-5\",\n \"examDeliverySystemModule\": \"canvas\",\n \"contactUserSid\": \"US1234567890abcdef1234567890abcdef\",\n \"isLimitedScope\": false,\n \"status\": \"active\"\n}"
response = http.request(request)
puts response.read_body{
"sessionStatus": "<string>",
"sid": "<string>",
"courseSid": "<string>",
"applicationInstallSid": "<string>",
"title": "<string>",
"bVirtualTitle": "<string>",
"type": "<string>",
"description": "<string>",
"useProctorManager": true,
"requireApproval": true,
"enableAppointmentSuggestions": true,
"url": "<string>",
"status": "<string>",
"createdDate": "<string>",
"editDate": "<string>",
"contactUserSid": "<string>",
"examDeliverySystemModule": "<string>",
"summary": "<string>",
"pendingApprovals": 123,
"openSessionEvents": 123,
"course": "<string>",
"configuration": "<string>",
"examSession": "<string>",
"instructorName": "<string>",
"courseName": "<string>",
"totalSessions": 123,
"needsProctorSessions": 123,
"scriptName": "<string>",
"systemName": "<string>",
"isLimitedScope": true,
"platformVersion": "<string>"
}Exam
Create Exam
Creates a new exam configuration under the specified course.
The payload includes exam metadata (title, type, URL), proctoring configuration, permitted items, scheduling windows, and instructor-as-proctor settings.
POST
/
v1
/
installs
/
{installSid}
/
courses
/
{courseSid}
/
exams
Create Exam
curl --request POST \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"title": "Midterm Exam 1",
"type": "Online",
"useProctorManager": true,
"requireApproval": false,
"url": "<string>",
"enableAppointmentSuggestions": true,
"configuration": {
"instructorAsProctor": [
{
"location": "<string>",
"startTime": "1970-01-01T00:00:00.000Z",
"endTime": "<string>",
"capacity": 123
}
],
"examOpenDate": "1970-01-01T00:00:00.000Z",
"examCloseDate": "1970-01-01T00:00:00.000Z",
"password": "<string>",
"duration": 123,
"attempts": 123,
"requiredSoftware": "<string>",
"studentNotes": "<string>",
"permittedBathroomBreak": true,
"permittedBathroomBreakInformation": "<string>",
"permittedBlankPaper": true,
"permittedBlankPaperInformation": "<string>",
"permittedCalculator": true,
"permittedCalculatorInformation": "<string>",
"permittedDictionary": true,
"permittedDictionaryInformation": "<string>",
"permittedEarplugs": true,
"permittedEarplugsInformation": "<string>",
"permittedFormulaSheet": true,
"permittedFormulaSheetInformation": "<string>",
"permittedNotes": true,
"permittedNotesInformation": "<string>",
"permittedOtherItems": "<string>",
"permittedTextbook": true,
"permittedTextbookInformation": "<string>",
"permittedWebsites": true,
"permittedWebsitesInformation": "<string>",
"proctorNotes": "<string>",
"proctorTypes": [
"<string>"
],
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"apiExamId": "<string>",
"modalityOptions": {},
"virtualCalculatorType": "scientific-calc"
},
"description": "Covers chapters 1-5",
"examDeliverySystemModule": "canvas",
"contactUserSid": "US1234567890abcdef1234567890abcdef",
"isLimitedScope": false,
"status": "active"
}
'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams"
payload = {
"title": "Midterm Exam 1",
"type": "Online",
"useProctorManager": True,
"requireApproval": False,
"url": "<string>",
"enableAppointmentSuggestions": True,
"configuration": {
"instructorAsProctor": [
{
"location": "<string>",
"startTime": "1970-01-01T00:00:00.000Z",
"endTime": "<string>",
"capacity": 123
}
],
"examOpenDate": "1970-01-01T00:00:00.000Z",
"examCloseDate": "1970-01-01T00:00:00.000Z",
"password": "<string>",
"duration": 123,
"attempts": 123,
"requiredSoftware": "<string>",
"studentNotes": "<string>",
"permittedBathroomBreak": True,
"permittedBathroomBreakInformation": "<string>",
"permittedBlankPaper": True,
"permittedBlankPaperInformation": "<string>",
"permittedCalculator": True,
"permittedCalculatorInformation": "<string>",
"permittedDictionary": True,
"permittedDictionaryInformation": "<string>",
"permittedEarplugs": True,
"permittedEarplugsInformation": "<string>",
"permittedFormulaSheet": True,
"permittedFormulaSheetInformation": "<string>",
"permittedNotes": True,
"permittedNotesInformation": "<string>",
"permittedOtherItems": "<string>",
"permittedTextbook": True,
"permittedTextbookInformation": "<string>",
"permittedWebsites": True,
"permittedWebsitesInformation": "<string>",
"proctorNotes": "<string>",
"proctorTypes": ["<string>"],
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"apiExamId": "<string>",
"modalityOptions": {},
"virtualCalculatorType": "scientific-calc"
},
"description": "Covers chapters 1-5",
"examDeliverySystemModule": "canvas",
"contactUserSid": "US1234567890abcdef1234567890abcdef",
"isLimitedScope": False,
"status": "active"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Midterm Exam 1',
type: 'Online',
useProctorManager: true,
requireApproval: false,
url: '<string>',
enableAppointmentSuggestions: true,
configuration: {
instructorAsProctor: [
{
location: '<string>',
startTime: '1970-01-01T00:00:00.000Z',
endTime: '<string>',
capacity: 123
}
],
examOpenDate: '1970-01-01T00:00:00.000Z',
examCloseDate: '1970-01-01T00:00:00.000Z',
password: '<string>',
duration: 123,
attempts: 123,
requiredSoftware: '<string>',
studentNotes: '<string>',
permittedBathroomBreak: true,
permittedBathroomBreakInformation: '<string>',
permittedBlankPaper: true,
permittedBlankPaperInformation: '<string>',
permittedCalculator: true,
permittedCalculatorInformation: '<string>',
permittedDictionary: true,
permittedDictionaryInformation: '<string>',
permittedEarplugs: true,
permittedEarplugsInformation: '<string>',
permittedFormulaSheet: true,
permittedFormulaSheetInformation: '<string>',
permittedNotes: true,
permittedNotesInformation: '<string>',
permittedOtherItems: '<string>',
permittedTextbook: true,
permittedTextbookInformation: '<string>',
permittedWebsites: true,
permittedWebsitesInformation: '<string>',
proctorNotes: '<string>',
proctorTypes: ['<string>'],
scheduleOpenDate: '1970-01-01T00:00:00.000Z',
scheduleCloseDate: '1970-01-01T00:00:00.000Z',
apiExamId: '<string>',
modalityOptions: {},
virtualCalculatorType: 'scientific-calc'
},
description: 'Covers chapters 1-5',
examDeliverySystemModule: 'canvas',
contactUserSid: 'US1234567890abcdef1234567890abcdef',
isLimitedScope: false,
status: 'active'
})
};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'Midterm Exam 1',
'type' => 'Online',
'useProctorManager' => true,
'requireApproval' => false,
'url' => '<string>',
'enableAppointmentSuggestions' => true,
'configuration' => [
'instructorAsProctor' => [
[
'location' => '<string>',
'startTime' => '1970-01-01T00:00:00.000Z',
'endTime' => '<string>',
'capacity' => 123
]
],
'examOpenDate' => '1970-01-01T00:00:00.000Z',
'examCloseDate' => '1970-01-01T00:00:00.000Z',
'password' => '<string>',
'duration' => 123,
'attempts' => 123,
'requiredSoftware' => '<string>',
'studentNotes' => '<string>',
'permittedBathroomBreak' => true,
'permittedBathroomBreakInformation' => '<string>',
'permittedBlankPaper' => true,
'permittedBlankPaperInformation' => '<string>',
'permittedCalculator' => true,
'permittedCalculatorInformation' => '<string>',
'permittedDictionary' => true,
'permittedDictionaryInformation' => '<string>',
'permittedEarplugs' => true,
'permittedEarplugsInformation' => '<string>',
'permittedFormulaSheet' => true,
'permittedFormulaSheetInformation' => '<string>',
'permittedNotes' => true,
'permittedNotesInformation' => '<string>',
'permittedOtherItems' => '<string>',
'permittedTextbook' => true,
'permittedTextbookInformation' => '<string>',
'permittedWebsites' => true,
'permittedWebsitesInformation' => '<string>',
'proctorNotes' => '<string>',
'proctorTypes' => [
'<string>'
],
'scheduleOpenDate' => '1970-01-01T00:00:00.000Z',
'scheduleCloseDate' => '1970-01-01T00:00:00.000Z',
'apiExamId' => '<string>',
'modalityOptions' => [
],
'virtualCalculatorType' => 'scientific-calc'
],
'description' => 'Covers chapters 1-5',
'examDeliverySystemModule' => 'canvas',
'contactUserSid' => 'US1234567890abcdef1234567890abcdef',
'isLimitedScope' => false,
'status' => 'active'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams"
payload := strings.NewReader("{\n \"title\": \"Midterm Exam 1\",\n \"type\": \"Online\",\n \"useProctorManager\": true,\n \"requireApproval\": false,\n \"url\": \"<string>\",\n \"enableAppointmentSuggestions\": true,\n \"configuration\": {\n \"instructorAsProctor\": [\n {\n \"location\": \"<string>\",\n \"startTime\": \"1970-01-01T00:00:00.000Z\",\n \"endTime\": \"<string>\",\n \"capacity\": 123\n }\n ],\n \"examOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"examCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"password\": \"<string>\",\n \"duration\": 123,\n \"attempts\": 123,\n \"requiredSoftware\": \"<string>\",\n \"studentNotes\": \"<string>\",\n \"permittedBathroomBreak\": true,\n \"permittedBathroomBreakInformation\": \"<string>\",\n \"permittedBlankPaper\": true,\n \"permittedBlankPaperInformation\": \"<string>\",\n \"permittedCalculator\": true,\n \"permittedCalculatorInformation\": \"<string>\",\n \"permittedDictionary\": true,\n \"permittedDictionaryInformation\": \"<string>\",\n \"permittedEarplugs\": true,\n \"permittedEarplugsInformation\": \"<string>\",\n \"permittedFormulaSheet\": true,\n \"permittedFormulaSheetInformation\": \"<string>\",\n \"permittedNotes\": true,\n \"permittedNotesInformation\": \"<string>\",\n \"permittedOtherItems\": \"<string>\",\n \"permittedTextbook\": true,\n \"permittedTextbookInformation\": \"<string>\",\n \"permittedWebsites\": true,\n \"permittedWebsitesInformation\": \"<string>\",\n \"proctorNotes\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"apiExamId\": \"<string>\",\n \"modalityOptions\": {},\n \"virtualCalculatorType\": \"scientific-calc\"\n },\n \"description\": \"Covers chapters 1-5\",\n \"examDeliverySystemModule\": \"canvas\",\n \"contactUserSid\": \"US1234567890abcdef1234567890abcdef\",\n \"isLimitedScope\": false,\n \"status\": \"active\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Midterm Exam 1\",\n \"type\": \"Online\",\n \"useProctorManager\": true,\n \"requireApproval\": false,\n \"url\": \"<string>\",\n \"enableAppointmentSuggestions\": true,\n \"configuration\": {\n \"instructorAsProctor\": [\n {\n \"location\": \"<string>\",\n \"startTime\": \"1970-01-01T00:00:00.000Z\",\n \"endTime\": \"<string>\",\n \"capacity\": 123\n }\n ],\n \"examOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"examCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"password\": \"<string>\",\n \"duration\": 123,\n \"attempts\": 123,\n \"requiredSoftware\": \"<string>\",\n \"studentNotes\": \"<string>\",\n \"permittedBathroomBreak\": true,\n \"permittedBathroomBreakInformation\": \"<string>\",\n \"permittedBlankPaper\": true,\n \"permittedBlankPaperInformation\": \"<string>\",\n \"permittedCalculator\": true,\n \"permittedCalculatorInformation\": \"<string>\",\n \"permittedDictionary\": true,\n \"permittedDictionaryInformation\": \"<string>\",\n \"permittedEarplugs\": true,\n \"permittedEarplugsInformation\": \"<string>\",\n \"permittedFormulaSheet\": true,\n \"permittedFormulaSheetInformation\": \"<string>\",\n \"permittedNotes\": true,\n \"permittedNotesInformation\": \"<string>\",\n \"permittedOtherItems\": \"<string>\",\n \"permittedTextbook\": true,\n \"permittedTextbookInformation\": \"<string>\",\n \"permittedWebsites\": true,\n \"permittedWebsitesInformation\": \"<string>\",\n \"proctorNotes\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"apiExamId\": \"<string>\",\n \"modalityOptions\": {},\n \"virtualCalculatorType\": \"scientific-calc\"\n },\n \"description\": \"Covers chapters 1-5\",\n \"examDeliverySystemModule\": \"canvas\",\n \"contactUserSid\": \"US1234567890abcdef1234567890abcdef\",\n \"isLimitedScope\": false,\n \"status\": \"active\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Midterm Exam 1\",\n \"type\": \"Online\",\n \"useProctorManager\": true,\n \"requireApproval\": false,\n \"url\": \"<string>\",\n \"enableAppointmentSuggestions\": true,\n \"configuration\": {\n \"instructorAsProctor\": [\n {\n \"location\": \"<string>\",\n \"startTime\": \"1970-01-01T00:00:00.000Z\",\n \"endTime\": \"<string>\",\n \"capacity\": 123\n }\n ],\n \"examOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"examCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"password\": \"<string>\",\n \"duration\": 123,\n \"attempts\": 123,\n \"requiredSoftware\": \"<string>\",\n \"studentNotes\": \"<string>\",\n \"permittedBathroomBreak\": true,\n \"permittedBathroomBreakInformation\": \"<string>\",\n \"permittedBlankPaper\": true,\n \"permittedBlankPaperInformation\": \"<string>\",\n \"permittedCalculator\": true,\n \"permittedCalculatorInformation\": \"<string>\",\n \"permittedDictionary\": true,\n \"permittedDictionaryInformation\": \"<string>\",\n \"permittedEarplugs\": true,\n \"permittedEarplugsInformation\": \"<string>\",\n \"permittedFormulaSheet\": true,\n \"permittedFormulaSheetInformation\": \"<string>\",\n \"permittedNotes\": true,\n \"permittedNotesInformation\": \"<string>\",\n \"permittedOtherItems\": \"<string>\",\n \"permittedTextbook\": true,\n \"permittedTextbookInformation\": \"<string>\",\n \"permittedWebsites\": true,\n \"permittedWebsitesInformation\": \"<string>\",\n \"proctorNotes\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"apiExamId\": \"<string>\",\n \"modalityOptions\": {},\n \"virtualCalculatorType\": \"scientific-calc\"\n },\n \"description\": \"Covers chapters 1-5\",\n \"examDeliverySystemModule\": \"canvas\",\n \"contactUserSid\": \"US1234567890abcdef1234567890abcdef\",\n \"isLimitedScope\": false,\n \"status\": \"active\"\n}"
response = http.request(request)
puts response.read_body{
"sessionStatus": "<string>",
"sid": "<string>",
"courseSid": "<string>",
"applicationInstallSid": "<string>",
"title": "<string>",
"bVirtualTitle": "<string>",
"type": "<string>",
"description": "<string>",
"useProctorManager": true,
"requireApproval": true,
"enableAppointmentSuggestions": true,
"url": "<string>",
"status": "<string>",
"createdDate": "<string>",
"editDate": "<string>",
"contactUserSid": "<string>",
"examDeliverySystemModule": "<string>",
"summary": "<string>",
"pendingApprovals": 123,
"openSessionEvents": 123,
"course": "<string>",
"configuration": "<string>",
"examSession": "<string>",
"instructorName": "<string>",
"courseName": "<string>",
"totalSessions": 123,
"needsProctorSessions": 123,
"scriptName": "<string>",
"systemName": "<string>",
"isLimitedScope": true,
"platformVersion": "<string>"
}Authorizations
Path Parameters
Unique SID of the application install. Pattern: AI + 32 hex chars.
Pattern:
^AI[a-f0-9]{32}$Example:
"AI1234567890abcdef1234567890abcdef"
Unique SID of the course. Pattern: CU + 32 hex chars.
Pattern:
^CU[a-f0-9]{32}$Example:
"CU1234567890abcdef1234567890abcdef"
Body
application/json
Payload for creating a new exam with full configuration.
Display title for the exam.
Example:
"Midterm Exam 1"
Exam type. Online for web-based exams (requires URL and password), Written for paper-based exams.
Available options:
Online, Written Example:
"Online"
Whether to use the proctor manager for automated proctor assignment.
Example:
true
Whether exam sessions require manual approval before the student can begin.
Example:
false
Exam URL
Whether to show suggested appointment time slots to students during scheduling.
Example:
true
Show child attributes
Show child attributes
Optional description providing additional details about the exam.
Example:
"Covers chapters 1-5"
Identifier for the exam delivery system module (e.g., LMS integration module name). Optional field controlled by feature flag.
Example:
"canvas"
SID of the user to contact for exam-related issues. Pattern: US + 32 hex chars.
Pattern:
^US[a-f0-9]{32}$Example:
"US1234567890abcdef1234567890abcdef"
When true, the exam is assigned to specific students only. When false, all enrolled students can take the exam.
Example:
false
Status of the exam. active exams are visible to students, draft are in preparation, deleted are soft-deleted.
Available options:
active, draft, deleted Example:
"active"
Response
200 - application/json
Successful
Session status
Exam SID
Course SID
Application install SID
Exam title
Virtual title
Exam type
Description
Use proctor manager
Require approval
Enable appointment suggestions
Exam URL
Exam status
Created date
Last modified date
Contact user SID
Exam delivery system module
Exam summary
Pending approvals count
Open session events count
Course details
Exam configuration
Exam session
Instructor name
Course name
Total sessions
Sessions needing proctor
Script name
System name
Is limited scope
Platform version
Was this page helpful?