SMsmarterproctoring
App Install

Get Settings

Changed on

Returns the full settings object for the specified application install, including configuration options such as facial processing, proctor types, exam notes, and more.<br/><br/>A valid authentication token must be provided in the token header.

get/v1/installs/{installSid}/settings

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/settings
  • Auth
    API key in header token

Path parameters

installSidstring required

Unique SID of the application install. Must match the pattern AI followed by 32 hex characters.

Example:AI1234567890abcdef1234567890abcdef

Response

Successful

sidstring nullable

Install SID

deploymentSidstring nullable

Deployment SID

applicationSidstring nullable

Application SID

defaultCourseOfferingSidstring nullable

Default course offering SID

namestring nullable

Install name

defaultCurrencyCodestring nullable

Default currency code

defaultTimezonestring nullable

Default timezone

requireManagerProctorApprovalboolean nullable

Require manager proctor approval

requireManagerExamApprovalboolean nullable

Require manager exam approval

smarterIdEnabledboolean nullable

SmarterID enabled

examNotesstring nullable

Exam notes

enableWrittenExamsboolean nullable

Enable written exams

defaultNewExamTypestring nullable

Default new exam type

hidePermittedItemFieldsstring[] nullable

Hidden permitted item fields

enabledboolean nullable

Whether install is enabled

createdDatestring nullable

Created date

editDatestring nullable

Last modified date

facialProcessingstring nullable

Facial processing mode

pauseForProctorReviewboolean nullable

Pause for proctor review

allowedExtensionIdsstring[] nullable

Allowed extension IDs

mandatoryRoomScanVideoboolean nullable

Mandatory room scan video

secureSessionStatusstring nullable

Secure session status

allowedSitesstring nullable

Allowed sites document

Changes