List enrollment exam sessions
curl --request GET \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions \
--header 'token: <api-key>'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions', 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}/enrollments/{enrollmentSid}/exams/{examSid}/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total": 123,
"first": "<string>",
"next": "<string>",
"prev": "<string>",
"last": "<string>",
"count": 123,
"offset": 123,
"results": [
{
"sid": "<string>",
"status": "<string>",
"sessionType": "<string>",
"appointmentDate": "<string>",
"createdDate": "<string>",
"editDate": "<string>"
}
]
}Exam Session
List enrollment exam sessions
Returns a paginated list of exam sessions for the given enrollment and exam combination.
GET
/
v1
/
installs
/
{installSid}
/
enrollments
/
{enrollmentSid}
/
exams
/
{examSid}
/
sessions
List enrollment exam sessions
curl --request GET \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions \
--header 'token: <api-key>'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions', 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}/enrollments/{enrollmentSid}/exams/{examSid}/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total": 123,
"first": "<string>",
"next": "<string>",
"prev": "<string>",
"last": "<string>",
"count": 123,
"offset": 123,
"results": [
{
"sid": "<string>",
"status": "<string>",
"sessionType": "<string>",
"appointmentDate": "<string>",
"createdDate": "<string>",
"editDate": "<string>"
}
]
}Authorizations
Path Parameters
Install Sid
Pattern:
^AI[a-f0-9]{32}$Enrollment Sid
Pattern:
^EN[a-f0-9]{32}$Exam Sid
Pattern:
^EX[a-f0-9]{32}$Query Parameters
Id to get next portion of query data. For 1st query should pass as empty
Required range:
x >= 0Number of items to return
Required range:
x >= 0Sort keys
Available options:
createdDate Sort order
Available options:
ASC, DESC Status List
Available options:
Needs Proctor, Pending Approval, Approval Denied, Scheduled, Incident, Closed, Processing Include Active Session
Response
200 - application/json
Successful
Total number of results
URL for first page
URL for next page
URL for previous page
URL for last page
Number of results in this page
Current offset
Exam session records
Show child attributes
Show child attributes
Was this page helpful?
