Create Configuration
curl --request POST \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"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",
"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>",
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"enrollmentSid": "<string>",
"url": "<string>",
"password": "<string>",
"virtualCalculatorType": "<string>",
"proctorTypes": [
"<string>"
],
"referenceExamConfigurationSid": "<string>",
"modalityOptions": {}
}
'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations"
payload = {
"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",
"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>",
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"enrollmentSid": "<string>",
"url": "<string>",
"password": "<string>",
"virtualCalculatorType": "<string>",
"proctorTypes": ["<string>"],
"referenceExamConfigurationSid": "<string>",
"modalityOptions": {}
}
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({
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',
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>',
scheduleOpenDate: '1970-01-01T00:00:00.000Z',
scheduleCloseDate: '1970-01-01T00:00:00.000Z',
enrollmentSid: '<string>',
url: '<string>',
password: '<string>',
virtualCalculatorType: '<string>',
proctorTypes: ['<string>'],
referenceExamConfigurationSid: '<string>',
modalityOptions: {}
})
};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations', 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/{examSid}/configurations",
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([
'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',
'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>',
'scheduleOpenDate' => '1970-01-01T00:00:00.000Z',
'scheduleCloseDate' => '1970-01-01T00:00:00.000Z',
'enrollmentSid' => '<string>',
'url' => '<string>',
'password' => '<string>',
'virtualCalculatorType' => '<string>',
'proctorTypes' => [
'<string>'
],
'referenceExamConfigurationSid' => '<string>',
'modalityOptions' => [
]
]),
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/{examSid}/configurations"
payload := strings.NewReader("{\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 \"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 \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"enrollmentSid\": \"<string>\",\n \"url\": \"<string>\",\n \"password\": \"<string>\",\n \"virtualCalculatorType\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"referenceExamConfigurationSid\": \"<string>\",\n \"modalityOptions\": {}\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/{examSid}/configurations")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"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 \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"enrollmentSid\": \"<string>\",\n \"url\": \"<string>\",\n \"password\": \"<string>\",\n \"virtualCalculatorType\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"referenceExamConfigurationSid\": \"<string>\",\n \"modalityOptions\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations")
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 \"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 \"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 \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"enrollmentSid\": \"<string>\",\n \"url\": \"<string>\",\n \"password\": \"<string>\",\n \"virtualCalculatorType\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"referenceExamConfigurationSid\": \"<string>\",\n \"modalityOptions\": {}\n}"
response = http.request(request)
puts response.read_body{
"sid": "<string>",
"examSid": "<string>",
"enrollmentSid": "<string>",
"referenceExamConfigurationSid": "<string>",
"type": "<string>",
"examOpenDate": "<string>",
"examCloseDate": "<string>",
"scheduleOpenDate": "<string>",
"scheduleCloseDate": "<string>",
"password": "<string>",
"url": "<string>",
"duration": 123,
"attempts": 123,
"attemptsRemaining": 123,
"locked": true,
"approved": true,
"approvedBy": "<string>",
"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>",
"apiExamId": "<string>",
"examSyncStatus": "<string>",
"virtualCalculatorType": "<string>",
"synchronization": "<string>",
"proctorNotes": "<string>",
"proctorTypes": [
"<string>"
],
"attachments": "<string>",
"examFiles": "<string>",
"instructorAsProctor": [
"<string>"
],
"exam": "<string>",
"course": "<string>",
"enrollment": "<string>",
"createdDate": "<string>",
"editDate": "<string>",
"instructor": "<string>",
"modalityOptions": "<string>",
"updatedAutomatedSessions": "<string>"
}Exam Configuration
Create Configuration
Creates a new exam configuration (e.g., student-specific overrides for scheduling windows, permitted items, and proctoring settings).
The payload must include either enrollmentSid or referenceExamConfigurationSid (XOR constraint).
POST
/
v1
/
installs
/
{installSid}
/
courses
/
{courseSid}
/
exams
/
{examSid}
/
configurations
Create Configuration
curl --request POST \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"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",
"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>",
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"enrollmentSid": "<string>",
"url": "<string>",
"password": "<string>",
"virtualCalculatorType": "<string>",
"proctorTypes": [
"<string>"
],
"referenceExamConfigurationSid": "<string>",
"modalityOptions": {}
}
'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations"
payload = {
"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",
"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>",
"scheduleOpenDate": "1970-01-01T00:00:00.000Z",
"scheduleCloseDate": "1970-01-01T00:00:00.000Z",
"enrollmentSid": "<string>",
"url": "<string>",
"password": "<string>",
"virtualCalculatorType": "<string>",
"proctorTypes": ["<string>"],
"referenceExamConfigurationSid": "<string>",
"modalityOptions": {}
}
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({
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',
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>',
scheduleOpenDate: '1970-01-01T00:00:00.000Z',
scheduleCloseDate: '1970-01-01T00:00:00.000Z',
enrollmentSid: '<string>',
url: '<string>',
password: '<string>',
virtualCalculatorType: '<string>',
proctorTypes: ['<string>'],
referenceExamConfigurationSid: '<string>',
modalityOptions: {}
})
};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations', 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/{examSid}/configurations",
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([
'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',
'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>',
'scheduleOpenDate' => '1970-01-01T00:00:00.000Z',
'scheduleCloseDate' => '1970-01-01T00:00:00.000Z',
'enrollmentSid' => '<string>',
'url' => '<string>',
'password' => '<string>',
'virtualCalculatorType' => '<string>',
'proctorTypes' => [
'<string>'
],
'referenceExamConfigurationSid' => '<string>',
'modalityOptions' => [
]
]),
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/{examSid}/configurations"
payload := strings.NewReader("{\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 \"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 \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"enrollmentSid\": \"<string>\",\n \"url\": \"<string>\",\n \"password\": \"<string>\",\n \"virtualCalculatorType\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"referenceExamConfigurationSid\": \"<string>\",\n \"modalityOptions\": {}\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/{examSid}/configurations")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"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 \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"enrollmentSid\": \"<string>\",\n \"url\": \"<string>\",\n \"password\": \"<string>\",\n \"virtualCalculatorType\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"referenceExamConfigurationSid\": \"<string>\",\n \"modalityOptions\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations")
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 \"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 \"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 \"scheduleOpenDate\": \"1970-01-01T00:00:00.000Z\",\n \"scheduleCloseDate\": \"1970-01-01T00:00:00.000Z\",\n \"enrollmentSid\": \"<string>\",\n \"url\": \"<string>\",\n \"password\": \"<string>\",\n \"virtualCalculatorType\": \"<string>\",\n \"proctorTypes\": [\n \"<string>\"\n ],\n \"referenceExamConfigurationSid\": \"<string>\",\n \"modalityOptions\": {}\n}"
response = http.request(request)
puts response.read_body{
"sid": "<string>",
"examSid": "<string>",
"enrollmentSid": "<string>",
"referenceExamConfigurationSid": "<string>",
"type": "<string>",
"examOpenDate": "<string>",
"examCloseDate": "<string>",
"scheduleOpenDate": "<string>",
"scheduleCloseDate": "<string>",
"password": "<string>",
"url": "<string>",
"duration": 123,
"attempts": 123,
"attemptsRemaining": 123,
"locked": true,
"approved": true,
"approvedBy": "<string>",
"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>",
"apiExamId": "<string>",
"examSyncStatus": "<string>",
"virtualCalculatorType": "<string>",
"synchronization": "<string>",
"proctorNotes": "<string>",
"proctorTypes": [
"<string>"
],
"attachments": "<string>",
"examFiles": "<string>",
"instructorAsProctor": [
"<string>"
],
"exam": "<string>",
"course": "<string>",
"enrollment": "<string>",
"createdDate": "<string>",
"editDate": "<string>",
"instructor": "<string>",
"modalityOptions": "<string>",
"updatedAutomatedSessions": "<string>"
}Authorizations
Path Parameters
Application install sid
Pattern:
^AI[a-f0-9]{32}$Course Sid
Pattern:
^CU[a-f0-9]{32}$Exam Sid
Pattern:
^EX[a-f0-9]{32}$Body
application/json
Exam Configuration payload
List of Instructor as Proctor
Show child attributes
Show child attributes
Exam Open Date
Pattern:
.*ZExample:
"1970-01-01T00:00:00.000Z"
Exam Close Date
Pattern:
.*ZExample:
"1970-01-01T00:00:00.000Z"
Duration Minutes
Attempts Allowed
Required Software
Student Notes
Is Bathroom Break permitted
Additional Information about bathroom break
Is blank paper permitted
Additional Information about blank paper
Is calculator permitted
Additional Information about calculator
Is Dictionary permitted
Additional Information about Dictionary
Is Earplugs permitted
Additional Information about Earplugs
Is FormulaSheet permitted
Additional Information about FormulaSheet
Is Notes permitted
Additional Information about Notes
Other permitted Items
Is Textbook permitted
Additional Information about Textbook
Is Websites permitted
Additional Information about Websites
Proctor Notes
Schedule Open Date
Pattern:
.*ZExample:
"1970-01-01T00:00:00.000Z"
Schedule Close Date
Pattern:
.*ZExample:
"1970-01-01T00:00:00.000Z"
Enrollment sid
Pattern:
^EN[a-f0-9]{32}$Exam Url
Password
Virtual Calculator Type
Types of proctor for exam
Pattern:
^TS[a-f0-9]{32}$referenceExamConfigurationSid
Pattern:
^EC[a-f0-9]{32}$List of modality options
Response
200 - application/json
Successful
Configuration SID
Exam SID
Enrollment SID
Reference exam configuration SID
Configuration type
Exam open date
Exam close date
Schedule open date
Schedule close date
Exam password
Exam URL
Duration in minutes
Number of attempts
Attempts remaining
Whether locked
Whether approved
Approved by
Required software
Student notes
Bathroom break permitted
Bathroom break info
Blank paper permitted
Blank paper info
Calculator permitted
Calculator info
Dictionary permitted
Dictionary info
Earplugs permitted
Earplugs info
Formula sheet permitted
Formula sheet info
Notes permitted
Notes info
Other permitted items
Textbook permitted
Textbook info
Websites permitted
Websites info
API exam ID
Exam sync status
Virtual calculator type
Synchronization info
Proctor notes
Proctor types
Attachments
Exam files
Instructor as proctor
Associated exam
Associated course
Associated enrollment
Created date
Last modified date
Instructor details
Modality options
Updated automated sessions
Was this page helpful?