Cancel Exam Session - SmarterServices Platform

Cancel Exam Session

curl --request DELETE \
  --url https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid} \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "cancellationMemo": "<string>",
  "bypassNonRefundable": false
}
'

import requests

url = "https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}"

payload = {
    "cancellationMemo": "<string>",
    "bypassNonRefundable": False
}
headers = {
    "token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cancellationMemo: '<string>', bypassNonRefundable: false})
};

fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}', 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}/exams/{examSid}/sessions/{sessionSid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellationMemo' => '<string>',
    'bypassNonRefundable' => false
  ]),
  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}/exams/{examSid}/sessions/{sessionSid}"

	payload := strings.NewReader("{\n  \"cancellationMemo\": \"<string>\",\n  \"bypassNonRefundable\": false\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}")
  .header("token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancellationMemo\": \"<string>\",\n  \"bypassNonRefundable\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancellationMemo\": \"<string>\",\n  \"bypassNonRefundable\": false\n}"

response = http.request(request)
puts response.read_body

"<string>"

DELETE

/

v1

/

installs

/

{installSid}

/

exams

/

{examSid}

/

sessions

/

{sessionSid}

Cancel Exam Session

curl --request DELETE \
  --url https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid} \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "cancellationMemo": "<string>",
  "bypassNonRefundable": false
}
'

import requests

url = "https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}"

payload = {
    "cancellationMemo": "<string>",
    "bypassNonRefundable": False
}
headers = {
    "token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cancellationMemo: '<string>', bypassNonRefundable: false})
};

fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}', 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}/exams/{examSid}/sessions/{sessionSid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellationMemo' => '<string>',
    'bypassNonRefundable' => false
  ]),
  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}/exams/{examSid}/sessions/{sessionSid}"

	payload := strings.NewReader("{\n  \"cancellationMemo\": \"<string>\",\n  \"bypassNonRefundable\": false\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}")
  .header("token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancellationMemo\": \"<string>\",\n  \"bypassNonRefundable\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancellationMemo\": \"<string>\",\n  \"bypassNonRefundable\": false\n}"

response = http.request(request)
puts response.read_body

"<string>"

Authorizations

token

string

header

required

Path Parameters

installSid

string

required

Install Sid

Pattern: ^AI[a-f0-9]{32}$

examSid

string

required

Exam Sid

Pattern: ^EX[a-f0-9]{32}$

sessionSid

string

required

Exam Session Sid

Pattern: ^ES[a-f0-9]{32}$

Body

application/json

cancellationMemo

string

required

Memo for cancelling the exam session

type

enum<string>

Available options:

b-virtual,

ad-hoc,

instructor-as-proctor,

messaging,

proctoru,

register-blast,

vtc,

examity,

smarter-scheduling,

automated

reason

enum<string>

Reason for session cancellation

Available options:

no-show,

changed-time,

technical-issue,

other-reason,

removed-by-limited-scope

bypassNonRefundable

boolean

default:false

Whether to bypass non-refundable scheduling fees. If true, all non-refundable fees will be refunded

Response

default - application/json

Successful

The response is of type string.

⌘I