{"servers":[{"url":"https://api.smarterproctoring.com"}],"info":{"title":"SmarterProctoring API","version":"3.0.4","description":"API documentation for SmarterProctoring"},"security":[{"client":[]}],"tags":[{"name":"App Install","description":"App Install operations","x-group":"App Install"},{"name":"Course","description":"Course operations","x-group":"Course"},{"name":"Course Offering","description":"Course Offering operations","x-group":"Course Offering"},{"name":"Exam","description":"Exam operations","x-group":"Exam"},{"name":"Exam Configuration","description":"Exam Configuration operations","x-group":"Exam Configuration"},{"name":"Exam Events","description":"Exam Events operations","x-group":"Exam Events"},{"name":"Exam Session","description":"Exam Session operations","x-group":"Exam Session"},{"name":"Exam Session Annotation","description":"Exam Session Annotation operations","x-group":"Exam Session Annotation"},{"name":"Exam Session Event","description":"Exam Session Event operations","x-group":"Exam Session Event"},{"name":"Onboarding","description":"Onboarding operations","x-group":"Onboarding"},{"name":"Provision","description":"Provision operations","x-group":"Provision"},{"name":"Reports","description":"Reports operations","x-group":"Reports"},{"name":"Time Zones","description":"Time Zones operations","x-group":"Time Zones"},{"name":"User","description":"User operations","x-group":"User"}],"openapi":"3.0.0","components":{"securitySchemes":{"client":{"type":"apiKey","name":"token","in":"header"}},"schemas":{"partnerMappings":{"type":"object"},"TimeZoneListItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"utcOffset":{"type":"string","nullable":true},"partnerMappings":{"$ref":"#/components/schemas/partnerMappings"}}},"results":{"type":"array","description":"Time zone records","items":{"$ref":"#/components/schemas/TimeZoneListItem"}},"TimeZoneListResponse":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"first":{"type":"string","description":"URL for first page","nullable":true},"next":{"type":"string","description":"URL for next page","nullable":true},"prev":{"type":"string","description":"URL for previous page","nullable":true},"last":{"type":"string","description":"URL for last page","nullable":true},"count":{"type":"number","description":"Number of results in this page"},"offset":{"type":"number","description":"Current offset"},"results":{"$ref":"#/components/schemas/results"}}},"ExamVolumeItem":{"type":"object","properties":{"courseTitle":{"type":"string","nullable":true},"courseCode":{"type":"string","nullable":true},"examTitle":{"type":"string","nullable":true},"examType":{"type":"string","nullable":true},"examOpenDate":{"type":"string","nullable":true},"examCloseDate":{"type":"string","nullable":true},"scheduleOpenDate":{"type":"string","nullable":true},"scheduleCloseDate":{"type":"string","nullable":true},"enrollment":{"type":"number","nullable":true},"unscheduledRemaining":{"type":"number","nullable":true}}},"Model1":{"type":"array","items":{"$ref":"#/components/schemas/ExamVolumeItem"}},"ExamVolumeReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model1"}}},"CourseOfferingListItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true}}},"Model2":{"type":"array","description":"Course offering records","items":{"$ref":"#/components/schemas/CourseOfferingListItem"}},"CourseOfferingListResponse":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"first":{"type":"string","description":"URL for first page","nullable":true},"next":{"type":"string","description":"URL for next page","nullable":true},"prev":{"type":"string","description":"URL for previous page","nullable":true},"last":{"type":"string","description":"URL for last page","nullable":true},"count":{"type":"number","description":"Number of results in this page"},"offset":{"type":"number","description":"Current offset"},"results":{"$ref":"#/components/schemas/Model2"}}},"hidePermittedItemFields":{"type":"array","description":"Hidden permitted item fields","nullable":true,"items":{"type":"string"}},"AppInstallProctorTypeResponse":{"type":"object","properties":{"sid":{"type":"string","description":"Proctor type SID","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"automaticallyApprove":{"type":"boolean","description":"Automatically approve","nullable":true},"proctorTypeSubCategorySid":{"type":"string","description":"Proctor type sub-category SID","nullable":true},"sessionConfigurationSid":{"type":"string","description":"Session configuration SID","nullable":true},"reconnectionLockoutPeriod":{"type":"number","description":"Reconnection lockout period in seconds","nullable":true},"reconnectionInSessionLockoutPeriod":{"type":"number","description":"Reconnection in-session lockout period in minutes","nullable":true},"maxReconnectionAttempts":{"type":"number","description":"Maximum reconnection attempts","nullable":true},"modalityOptionPresetSid":{"type":"string","description":"Modality option preset SID","nullable":true}}},"proctorTypes":{"type":"array","description":"Proctor types","items":{"$ref":"#/components/schemas/AppInstallProctorTypeResponse"}},"allowedExtensionIds":{"type":"array","description":"Allowed extension IDs","nullable":true,"items":{"type":"string"}},"AppInstallSettingsResponse":{"type":"object","properties":{"sid":{"type":"string","description":"Install SID","nullable":true},"deploymentSid":{"type":"string","description":"Deployment SID","nullable":true},"applicationSid":{"type":"string","description":"Application SID","nullable":true},"defaultCourseOfferingSid":{"type":"string","description":"Default course offering SID","nullable":true},"name":{"type":"string","description":"Install name","nullable":true},"defaultCurrencyCode":{"type":"string","description":"Default currency code","nullable":true},"defaultTimezone":{"type":"string","description":"Default timezone","nullable":true},"requireManagerProctorApproval":{"type":"boolean","description":"Require manager proctor approval","nullable":true},"requireManagerExamApproval":{"type":"boolean","description":"Require manager exam approval","nullable":true},"smarterIdEnabled":{"type":"boolean","description":"SmarterID enabled","nullable":true},"examNotes":{"type":"string","description":"Exam notes","nullable":true},"enableWrittenExams":{"type":"boolean","description":"Enable written exams","nullable":true},"defaultNewExamType":{"type":"string","description":"Default new exam type","nullable":true},"hidePermittedItemFields":{"$ref":"#/components/schemas/hidePermittedItemFields"},"proctorTypes":{"$ref":"#/components/schemas/proctorTypes"},"enabled":{"type":"boolean","description":"Whether install is enabled","nullable":true},"createdDate":{"type":"string","description":"Created date","nullable":true},"editDate":{"type":"string","description":"Last modified date","nullable":true},"facialProcessing":{"type":"string","description":"Facial processing mode","nullable":true},"pauseForProctorReview":{"type":"boolean","description":"Pause for proctor review","nullable":true},"allowedExtensionIds":{"$ref":"#/components/schemas/allowedExtensionIds"},"mandatoryRoomScanVideo":{"type":"boolean","description":"Mandatory room scan video","nullable":true},"secureSessionStatus":{"type":"string","description":"Secure session status","nullable":true},"allowedSites":{"type":"string","description":"Allowed sites document","nullable":true}}},"UserListItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true}}},"Model3":{"type":"array","description":"User records","items":{"$ref":"#/components/schemas/UserListItem"}},"UserListResponse":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"first":{"type":"string","description":"URL for first page","nullable":true},"next":{"type":"string","description":"URL for next page","nullable":true},"prev":{"type":"string","description":"URL for previous page","nullable":true},"last":{"type":"string","description":"URL for last page","nullable":true},"count":{"type":"number","description":"Number of results in this page"},"offset":{"type":"number","description":"Current offset"},"results":{"$ref":"#/components/schemas/Model3"}}},"Model4":{"type":"object"},"ExamByWeekItem":{"type":"array","items":{"$ref":"#/components/schemas/Model4"}},"ExamsByWeekReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true},"lastEvaluatedKey":{"type":"string","nullable":true},"results":{"$ref":"#/components/schemas/ExamByWeekItem"}}},"ProctorAccountVolumeItem":{"type":"object","properties":{"homeInstitution":{"type":"string","nullable":true},"sessionCount":{"type":"number","nullable":true},"proctorAccountName":{"type":"string","nullable":true},"proctorAccountLocationName":{"type":"string","nullable":true}}},"Model5":{"type":"array","items":{"$ref":"#/components/schemas/ProctorAccountVolumeItem"}},"ProctorAccountVolumeReportResponse":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/Model5"}}},"AuditReportItem":{"type":"object","properties":{"examSid":{"type":"string","nullable":true},"examTitle":{"type":"string","nullable":true},"courseSid":{"type":"string","nullable":true},"courseTitle":{"type":"string","nullable":true},"courseCode":{"type":"string","nullable":true},"examOpenDate":{"type":"string","nullable":true},"examCloseDate":{"type":"string","nullable":true},"configurationType":{"type":"string","nullable":true},"instructorSid":{"type":"string","nullable":true},"instructorFirstName":{"type":"string","nullable":true},"instructorLastName":{"type":"string","nullable":true},"instructorEmail":{"type":"string","nullable":true}}},"Model6":{"type":"array","items":{"$ref":"#/components/schemas/AuditReportItem"}},"AuditReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model6"}}},"SessionEventItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"appointmentDate":{"type":"string","nullable":true},"sessionType":{"type":"string","nullable":true},"courseTitle":{"type":"string","nullable":true},"examType":{"type":"string","nullable":true},"examTitle":{"type":"string","nullable":true},"sessionStatus":{"type":"string","nullable":true},"eventSid":{"type":"string","nullable":true},"eventTime":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"details":{"type":"string","nullable":true},"potentialDamage":{"type":"string","nullable":true},"directWitness":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"correctiveActionDetails":{"type":"string","nullable":true},"contactPerson":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"contactPhone":{"type":"string","nullable":true}}},"Model7":{"type":"array","items":{"$ref":"#/components/schemas/SessionEventItem"}},"SessionEventReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model7"}}},"series":{"type":"object"},"mutedAnnotations":{"type":"object"},"exam":{"type":"object","nullable":true,"properties":{"sid":{"type":"string","nullable":true},"courseSid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"useProctorManager":{"type":"boolean","nullable":true},"requireApproval":{"type":"boolean","nullable":true},"enableAppointmentSuggestions":{"type":"boolean","nullable":true},"url":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"instructorName":{"type":"string","nullable":true},"courseName":{"type":"string","nullable":true},"totalSessions":{"type":"number","nullable":true},"needsProctorSessions":{"type":"number","nullable":true},"platformVersion":{"type":"string","nullable":true}}},"synchronization":{"type":"object","nullable":true,"properties":{"failure1":{"type":"string","nullable":true},"failure2":{"type":"string","nullable":true},"failure3":{"type":"string","nullable":true},"failure4":{"type":"string","nullable":true},"lastSync":{"type":"string","nullable":true}}},"user":{"type":"object"},"course":{"type":"object"},"enrollment":{"type":"object","nullable":true,"properties":{"userSid":{"type":"string","nullable":true},"enrollmentSid":{"type":"string","nullable":true},"courseSid":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"synchronization":{"$ref":"#/components/schemas/synchronization"},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true},"user":{"$ref":"#/components/schemas/user"},"course":{"$ref":"#/components/schemas/course"}}},"Model8":{"type":"object","nullable":true,"properties":{"lastRun":{"type":"string","nullable":true},"lastRunResult":{"type":"string","nullable":true},"nextRun":{"type":"string","nullable":true}}},"Model9":{"type":"object","nullable":true,"properties":{"enrollment":{"$ref":"#/components/schemas/Model8"}}},"offering":{"type":"object","nullable":true,"properties":{"sid":{"type":"string","nullable":true},"lastActivityDate":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"matchStrings":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true}}},"Model10":{"type":"object","nullable":true,"properties":{"sid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"synchronization":{"$ref":"#/components/schemas/Model9"},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true},"offering":{"$ref":"#/components/schemas/offering"}}},"Model11":{"type":"object","nullable":true,"properties":{"lastRun":{"type":"string","nullable":true},"lastRunResult":{"type":"string","nullable":true},"nextRun":{"type":"string","nullable":true}}},"Model12":{"type":"object","nullable":true,"properties":{"exam":{"$ref":"#/components/schemas/Model11"}}},"Model13":{"type":"array","nullable":true,"items":{"type":"string"}},"Model14":{"type":"object"},"instructorAsProctor":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Model14"}},"examConfiguration":{"type":"object","nullable":true,"properties":{"sid":{"type":"string","nullable":true},"examSid":{"type":"string","nullable":true},"enrollmentSid":{"type":"string","nullable":true},"examOpenDate":{"type":"string","nullable":true},"examCloseDate":{"type":"string","nullable":true},"scheduleOpenDate":{"type":"string","nullable":true},"scheduleCloseDate":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"attempts":{"type":"number","nullable":true},"approved":{"type":"boolean","nullable":true},"approvedBy":{"type":"string","nullable":true},"requiredSoftware":{"type":"string","nullable":true},"studentNotes":{"type":"string","nullable":true},"permittedBathroomBreak":{"type":"boolean","nullable":true},"permittedBathroomBreakInformation":{"type":"string","nullable":true},"permittedBlankPaper":{"type":"boolean","nullable":true},"permittedBlankPaperInformation":{"type":"string","nullable":true},"permittedCalculator":{"type":"boolean","nullable":true},"permittedCalculatorInformation":{"type":"string","nullable":true},"permittedDictionary":{"type":"boolean","nullable":true},"permittedDictionaryInformation":{"type":"string","nullable":true},"permittedEarplugs":{"type":"boolean","nullable":true},"permittedEarplugsInformation":{"type":"string","nullable":true},"permittedFormulaSheet":{"type":"boolean","nullable":true},"permittedFormulaSheetInformation":{"type":"string","nullable":true},"permittedNotes":{"type":"boolean","nullable":true},"permittedNotesInformation":{"type":"string","nullable":true},"permittedOtherItems":{"type":"string","nullable":true},"permittedTextbook":{"type":"boolean","nullable":true},"permittedTextbookInformation":{"type":"string","nullable":true},"permittedWebsites":{"type":"boolean","nullable":true},"permittedWebsitesInformation":{"type":"string","nullable":true},"synchronization":{"$ref":"#/components/schemas/Model12"},"proctorNotes":{"type":"string","nullable":true},"proctorTypes":{"$ref":"#/components/schemas/Model13"},"instructorAsProctor":{"$ref":"#/components/schemas/instructorAsProctor"},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true}}},"AppointmentReportItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"examSid":{"type":"string","nullable":true},"enrollmentSid":{"type":"string","nullable":true},"instructorProctorSid":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"sessionType":{"type":"string","nullable":true},"schedulingModule":{"type":"string","nullable":true},"proctorReviewProcessSid":{"type":"string","nullable":true},"appointmentDate":{"type":"string","nullable":true},"dateApproved":{"type":"string","nullable":true},"dateScheduled":{"type":"string","nullable":true},"externalAppointmentId":{"type":"string","nullable":true},"externalReservedAppointmentId":{"type":"string","nullable":true},"externalReservedAppointmentExpires":{"type":"string","nullable":true},"recordingStartDate":{"type":"string","nullable":true},"sessionReportCount":{"type":"number","nullable":true},"series":{"$ref":"#/components/schemas/series"},"reviewByDate":{"type":"string","nullable":true},"reviewCompletedDate":{"type":"string","nullable":true},"reviewRequired":{"type":"boolean","nullable":true},"platformVersion":{"type":"string","nullable":true},"systemCheckStartDate":{"type":"string","nullable":true},"systemCheckEndDate":{"type":"string","nullable":true},"mandatoryRoomScanVideo":{"type":"boolean","nullable":true},"mutedAnnotations":{"$ref":"#/components/schemas/mutedAnnotations"},"exam":{"$ref":"#/components/schemas/exam"},"enrollment":{"$ref":"#/components/schemas/enrollment"},"course":{"$ref":"#/components/schemas/Model10"},"examConfiguration":{"$ref":"#/components/schemas/examConfiguration"}}},"Model15":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentReportItem"}},"AppointmentReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model15"}}},"ExamOverviewItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"courseSid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"bVirtualTitle":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"useProctorManager":{"type":"boolean","nullable":true},"requireApproval":{"type":"boolean","nullable":true},"enableAppointmentSuggestions":{"type":"boolean","nullable":true},"url":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true},"examDeliverySystemModule":{"type":"string","nullable":true},"instructorName":{"type":"string","nullable":true},"courseName":{"type":"string","nullable":true},"totalSessions":{"type":"number","nullable":true},"needsProctorSessions":{"type":"number","nullable":true},"platformVersion":{"type":"string","nullable":true}}},"Model16":{"type":"array","items":{"$ref":"#/components/schemas/ExamOverviewItem"}},"ExamOverviewReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model16"}}},"Model17":{"type":"object"},"courseOffering":{"type":"object"},"ServiceDistributionItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"statusReason":{"type":"string","nullable":true},"billable":{"type":"boolean","nullable":true},"schedulingModule":{"type":"string","nullable":true},"workflowModule":{"type":"string","nullable":true},"appointmentDate":{"type":"string","nullable":true},"dateClosed":{"type":"string","nullable":true},"dateCancelled":{"type":"string","nullable":true},"exam":{"$ref":"#/components/schemas/Model17"},"course":{"$ref":"#/components/schemas/course"},"user":{"$ref":"#/components/schemas/user"},"courseOffering":{"$ref":"#/components/schemas/courseOffering"},"serviceType":{"type":"string","nullable":true}}},"Model18":{"type":"array","items":{"$ref":"#/components/schemas/ServiceDistributionItem"}},"ServiceDistributionReportResponse":{"type":"object","properties":{"total":{"type":"number","description":"Total results","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model18"}}},"matchStrings":{"type":"array","description":"Match strings for auto-matching","nullable":true,"items":{"type":"string"}},"CourseOfferingResponse":{"type":"object","properties":{"sid":{"type":"string","description":"Course offering SID","nullable":true},"lastActivityDate":{"type":"string","description":"Last activity date","nullable":true},"title":{"type":"string","description":"Offering title","nullable":true},"matchStrings":{"$ref":"#/components/schemas/matchStrings"},"startDate":{"type":"string","description":"Start date","nullable":true},"endDate":{"type":"string","description":"End date","nullable":true},"createdDate":{"type":"string","description":"Created date","nullable":true},"editDate":{"type":"string","description":"Last modified date","nullable":true}}},"UnscheduledLearnerItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"preferredEmail":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"mobilePhone":{"type":"string","nullable":true},"homePhone":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"lmsId":{"type":"string","nullable":true},"apiId":{"type":"string","nullable":true},"sisId":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"lastEnrollmentSync":{"type":"string","nullable":true},"currencyCode":{"type":"string","nullable":true},"timeZoneSid":{"type":"string","nullable":true},"maxTravelDistance":{"type":"number","nullable":true},"maxTravelDistanceUnits":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true},"role":{"type":"string","nullable":true},"enabled":{"type":"boolean","nullable":true}}},"Model19":{"type":"array","items":{"$ref":"#/components/schemas/UnscheduledLearnerItem"}},"UnscheduledLearnersReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model19"}}},"data":{"type":"object","nullable":true,"properties":{"date":{"type":"string","nullable":true},"ad-hoc":{"type":"number","nullable":true},"b-virtual":{"type":"number","nullable":true},"instructor-as-proctor":{"type":"number","nullable":true},"messaging":{"type":"number","nullable":true},"register-blast":{"type":"number","nullable":true},"proctoru":{"type":"number","nullable":true},"examity":{"type":"number","nullable":true}}},"AggregatedStatsItem":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/data"}}},"Model20":{"type":"array","items":{"$ref":"#/components/schemas/AggregatedStatsItem"}},"AggregatedStatsReportResponse":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/Model20"}}},"Model21":{"type":"object"},"proctorAccount":{"type":"object"},"proctorAccountUser":{"type":"object"},"SessionRequestItem":{"type":"object","properties":{"messageThreadSid":{"type":"string","nullable":true},"dateOption1":{"type":"string","nullable":true},"dateOption2":{"type":"string","nullable":true},"dateOption3":{"type":"string","nullable":true},"confirmedDate":{"type":"string","nullable":true},"confirmedDateExpiration":{"type":"string","nullable":true},"sessionRequest":{"type":"boolean","nullable":true},"lastMessageDate":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"course":{"$ref":"#/components/schemas/course"},"exam":{"$ref":"#/components/schemas/Model21"},"user":{"$ref":"#/components/schemas/user"},"proctorAccount":{"$ref":"#/components/schemas/proctorAccount"},"proctorAccountUser":{"$ref":"#/components/schemas/proctorAccountUser"}}},"Model22":{"type":"array","items":{"$ref":"#/components/schemas/SessionRequestItem"}},"SessionRequestReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model22"}}},"ChurnReportItem":{"type":"object","properties":{"courseTitle":{"type":"string","nullable":true},"examSid":{"type":"string","nullable":true},"examTitle":{"type":"string","nullable":true},"examType":{"type":"string","nullable":true},"userSid":{"type":"string","nullable":true},"enrollmentSid":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"preferredEmail":{"type":"string","nullable":true},"homePhone":{"type":"string","nullable":true},"mobilePhone":{"type":"string","nullable":true},"currentSessionSid":{"type":"string","nullable":true},"currentStatus":{"type":"string","nullable":true},"cancelled":{"type":"boolean","nullable":true},"closed":{"type":"boolean","nullable":true}}},"Model23":{"type":"array","items":{"$ref":"#/components/schemas/ChurnReportItem"}},"ChurnReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model23"}}},"ad-hoc":{"type":"object","nullable":true,"properties":{"total":{"type":"number","nullable":true},"Scheduled":{"type":"number","nullable":true},"Closed":{"type":"number","nullable":true}}},"automated":{"type":"object","nullable":true,"properties":{"total":{"type":"number","nullable":true},"Scheduled":{"type":"number","nullable":true},"Closed":{"type":"number","nullable":true}}},"instructor-as-proctor":{"type":"object","nullable":true,"properties":{"total":{"type":"number","nullable":true},"Scheduled":{"type":"number","nullable":true},"Closed":{"type":"number","nullable":true}}},"messaging":{"type":"object","nullable":true,"properties":{"total":{"type":"number","nullable":true},"Scheduled":{"type":"number","nullable":true},"Closed":{"type":"number","nullable":true}}},"proctoru":{"type":"object","nullable":true,"properties":{"total":{"type":"number","nullable":true},"Scheduled":{"type":"number","nullable":true},"Closed":{"type":"number","nullable":true}}},"register-blast":{"type":"object","nullable":true,"properties":{"total":{"type":"number","nullable":true},"Scheduled":{"type":"number","nullable":true},"Closed":{"type":"number","nullable":true}}},"smarter-scheduling":{"type":"object","nullable":true,"properties":{"total":{"type":"number","nullable":true},"Scheduled":{"type":"number","nullable":true},"Closed":{"type":"number","nullable":true}}},"ModalityDistributionReportResponse":{"type":"object","properties":{"ad-hoc":{"$ref":"#/components/schemas/ad-hoc"},"automated":{"$ref":"#/components/schemas/automated"},"instructor-as-proctor":{"$ref":"#/components/schemas/instructor-as-proctor"},"messaging":{"$ref":"#/components/schemas/messaging"},"proctoru":{"$ref":"#/components/schemas/proctoru"},"register-blast":{"$ref":"#/components/schemas/register-blast"},"smarter-scheduling":{"$ref":"#/components/schemas/smarter-scheduling"}}},"Model24":{"type":"object","nullable":true,"properties":{"day":{"type":"string","nullable":true},"volume":{"type":"number","nullable":true}}},"dayOfWeek":{"type":"array","items":{"$ref":"#/components/schemas/Model24"}},"Model25":{"type":"object","nullable":true,"properties":{"hour":{"type":"number","nullable":true},"volume":{"type":"number","nullable":true}}},"perHour":{"type":"array","items":{"$ref":"#/components/schemas/Model25"}},"Model26":{"type":"object","nullable":true,"properties":{"day":{"type":"string","nullable":true},"volume":{"type":"number","nullable":true}}},"perDay":{"type":"array","items":{"$ref":"#/components/schemas/Model26"}},"AppointmentVolumeReportResponse":{"type":"object","properties":{"dayOfWeek":{"$ref":"#/components/schemas/dayOfWeek"},"perHour":{"$ref":"#/components/schemas/perHour"},"perDay":{"$ref":"#/components/schemas/perDay"}}},"configuration":{"type":"object"},"primaryInstructor":{"type":"object"},"ExamDetailsItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"courseSid":{"type":"string","nullable":true},"installSid":{"type":"string","nullable":true},"examConfigurationSid":{"type":"string","nullable":true},"primaryInstructorSid":{"type":"string","nullable":true},"examTitle":{"type":"string","nullable":true},"courseTitle":{"type":"string","nullable":true},"accountName":{"type":"string","nullable":true},"hasAttachments":{"type":"boolean","nullable":true},"configuration":{"$ref":"#/components/schemas/configuration"},"primaryInstructor":{"$ref":"#/components/schemas/primaryInstructor"}}},"Model27":{"type":"array","items":{"$ref":"#/components/schemas/ExamDetailsItem"}},"ExamDetailsReportResponse":{"type":"object","properties":{"total":{"type":"number","nullable":true},"first":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"count":{"type":"number","nullable":true},"offset":{"type":"number","nullable":true},"results":{"$ref":"#/components/schemas/Model27"}}},"timezone":{"type":"object","description":"Timezone details","nullable":true},"authentication":{"type":"object","description":"Authentication data","nullable":true},"smarterId":{"type":"object","description":"SmarterID data","nullable":true},"Model28":{"type":"object","description":"Course","nullable":true},"Model29":{"type":"object","description":"Exam","nullable":true},"identity":{"type":"object","description":"Identity","nullable":true},"UserResponse":{"type":"object","properties":{"sid":{"type":"string","description":"User SID","nullable":true},"firstName":{"type":"string","description":"First name","nullable":true},"lastName":{"type":"string","description":"Last name","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"preferredEmail":{"type":"string","description":"Preferred email","nullable":true},"username":{"type":"string","description":"Username","nullable":true},"smarterIdEnrollmentSid":{"type":"string","description":"SmarterID enrollment SID","nullable":true},"mobilePhone":{"type":"string","description":"Mobile phone","nullable":true},"homePhone":{"type":"string","description":"Home phone","nullable":true},"address":{"type":"string","description":"Address","nullable":true},"lmsId":{"type":"string","description":"LMS ID","nullable":true},"apiId":{"type":"string","description":"API ID","nullable":true},"sisId":{"type":"string","description":"SIS ID","nullable":true},"externalId":{"type":"string","description":"External ID","nullable":true},"latitude":{"type":"number","description":"Latitude","nullable":true},"longitude":{"type":"number","description":"Longitude","nullable":true},"lastEnrollmentSync":{"type":"string","description":"Last enrollment sync","nullable":true},"currencyCode":{"type":"string","description":"Currency code","nullable":true},"timeZoneSid":{"type":"string","description":"Time zone SID","nullable":true},"timezone":{"$ref":"#/components/schemas/timezone"},"maxTravelDistance":{"type":"number","description":"Max travel distance","nullable":true},"maxTravelDistanceUnits":{"type":"string","description":"Max travel distance units","nullable":true},"createdDate":{"type":"string","description":"Created date","nullable":true},"editDate":{"type":"string","description":"Edit date","nullable":true},"freshdeskUserId":{"type":"string","description":"Freshdesk user ID","nullable":true},"role":{"type":"string","description":"Role","nullable":true},"enabled":{"type":"boolean","description":"Enabled","nullable":true},"authentication":{"$ref":"#/components/schemas/authentication"},"smarterId":{"$ref":"#/components/schemas/smarterId"},"course":{"$ref":"#/components/schemas/Model28"},"exam":{"$ref":"#/components/schemas/Model29"},"identity":{"$ref":"#/components/schemas/identity"}}},"ExamResponse":{"type":"object","properties":{"sessionStatus":{"type":"string","description":"Session status","nullable":true},"sid":{"type":"string","description":"Exam SID","nullable":true},"courseSid":{"type":"string","description":"Course SID","nullable":true},"applicationInstallSid":{"type":"string","description":"Application install SID","nullable":true},"title":{"type":"string","description":"Exam title","nullable":true},"bVirtualTitle":{"type":"string","description":"Virtual title","nullable":true},"type":{"type":"string","description":"Exam type","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"useProctorManager":{"type":"boolean","description":"Use proctor manager","nullable":true},"requireApproval":{"type":"boolean","description":"Require approval","nullable":true},"enableAppointmentSuggestions":{"type":"boolean","description":"Enable appointment suggestions","nullable":true},"url":{"type":"string","description":"Exam URL","nullable":true},"status":{"type":"string","description":"Exam status","nullable":true},"createdDate":{"type":"string","description":"Created date","nullable":true},"editDate":{"type":"string","description":"Last modified date","nullable":true},"contactUserSid":{"type":"string","description":"Contact user SID","nullable":true},"examDeliverySystemModule":{"type":"string","description":"Exam delivery system module","nullable":true},"summary":{"type":"string","description":"Exam summary","nullable":true},"pendingApprovals":{"type":"number","description":"Pending approvals count","nullable":true},"openSessionEvents":{"type":"number","description":"Open session events count","nullable":true},"course":{"type":"string","description":"Course details","nullable":true},"configuration":{"type":"string","description":"Exam configuration","nullable":true},"examSession":{"type":"string","description":"Exam session","nullable":true},"instructorName":{"type":"string","description":"Instructor name","nullable":true},"courseName":{"type":"string","description":"Course name","nullable":true},"totalSessions":{"type":"number","description":"Total sessions","nullable":true},"needsProctorSessions":{"type":"number","description":"Sessions needing proctor","nullable":true},"scriptName":{"type":"string","description":"Script name","nullable":true},"systemName":{"type":"string","description":"System name","nullable":true},"isLimitedScope":{"type":"boolean","description":"Is limited scope","nullable":true},"platformVersion":{"type":"string","description":"Platform version","nullable":true}}},"messagingConfirmations":{"type":"array","description":"Messaging confirmations","nullable":true,"items":{"type":"string"}},"ExamSessionResponse":{"type":"object","properties":{"sid":{"type":"string","description":"Session SID","nullable":true},"installSid":{"type":"string","description":"Install SID","nullable":true},"examSid":{"type":"string","description":"Exam SID","nullable":true},"enrollmentSid":{"type":"string","description":"Enrollment SID","nullable":true},"userSid":{"type":"string","description":"User SID","nullable":true},"courseSid":{"type":"string","description":"Course SID","nullable":true},"instructorProctorSid":{"type":"string","description":"Instructor proctor SID","nullable":true},"proctorTypeSid":{"type":"string","description":"Proctor type SID","nullable":true},"cancellationPolicySid":{"type":"string","description":"Cancellation policy SID","nullable":true},"cancellationPolicyVersionSid":{"type":"string","description":"Cancellation policy version SID","nullable":true},"status":{"type":"string","description":"Session status","nullable":true},"statusReason":{"type":"string","description":"Status reason","nullable":true},"accessKey":{"type":"string","description":"Access key","nullable":true},"duration":{"type":"number","description":"Duration","nullable":true},"sessionType":{"type":"string","description":"Session type","nullable":true},"schedulingModule":{"type":"string","description":"Scheduling module","nullable":true},"proctorReviewProcessSid":{"type":"string","description":"Proctor review process SID","nullable":true},"workflowModule":{"type":"string","description":"Workflow module","nullable":true},"appointmentDate":{"type":"string","description":"Appointment date","nullable":true},"appointmentEndDate":{"type":"string","description":"Appointment end date","nullable":true},"dateApproved":{"type":"string","description":"Date approved","nullable":true},"dateScheduled":{"type":"string","description":"Date scheduled","nullable":true},"createdDate":{"type":"string","description":"Created date","nullable":true},"inProgressDate":{"type":"string","description":"In progress date","nullable":true},"externalAppointmentId":{"type":"string","description":"External appointment ID","nullable":true},"externalReservedAppointmentId":{"type":"string","description":"External reserved appointment ID","nullable":true},"externalReservedAppointmentExpires":{"type":"string","description":"External reserved appointment expires","nullable":true},"externalAppointmentSyncDate":{"type":"string","description":"External appointment sync date","nullable":true},"editDate":{"type":"string","description":"Last modified date","nullable":true},"notes":{"type":"string","description":"Notes","nullable":true},"recordingStartDate":{"type":"string","description":"Recording start date","nullable":true},"account":{"type":"string","description":"Account details","nullable":true},"install":{"type":"string","description":"Install details","nullable":true},"deployment":{"type":"string","description":"Deployment details","nullable":true},"sessionReportCount":{"type":"number","description":"Session report count","nullable":true},"series":{"type":"string","description":"Session series","nullable":true},"reviewByDate":{"type":"string","description":"Review by date","nullable":true},"reviewByUserSid":{"type":"string","description":"Review by user SID","nullable":true},"reviewCompletedDate":{"type":"string","description":"Review completed date","nullable":true},"reviewRequired":{"type":"boolean","description":"Review required","nullable":true},"reviewCompleteNotificationUrl":{"type":"string","description":"Review complete notification URL","nullable":true},"reviewed":{"type":"boolean","description":"Reviewed","nullable":true},"proctorGroups":{"type":"string","description":"Proctor groups","nullable":true},"URL":{"type":"string","description":"Session URL","nullable":true},"examLocale":{"type":"string","description":"Exam locale","nullable":true},"platformVersion":{"type":"string","description":"Platform version","nullable":true},"systemCheckStartDate":{"type":"string","description":"System check start date","nullable":true},"systemCheckEndDate":{"type":"string","description":"System check end date","nullable":true},"modalityOptions":{"type":"string","description":"Modality options","nullable":true},"exam":{"type":"string","description":"Exam details","nullable":true},"enrollment":{"type":"string","description":"Enrollment details","nullable":true},"course":{"type":"string","description":"Course details","nullable":true},"examFile":{"type":"string","description":"Exam file","nullable":true},"returnedFile":{"type":"string","description":"Returned file","nullable":true},"photos":{"type":"string","description":"Photos","nullable":true},"sessionInfo":{"type":"string","description":"Session info","nullable":true},"auditStatus":{"type":"string","description":"Audit status","nullable":true},"examConfiguration":{"type":"string","description":"Exam configuration","nullable":true},"proctor":{"type":"string","description":"Proctor details","nullable":true},"location":{"type":"string","description":"Location details","nullable":true},"appointment":{"type":"string","description":"Appointment details","nullable":true},"messagingConfirmations":{"$ref":"#/components/schemas/messagingConfirmations"},"automated":{"type":"string","description":"Automated session data","nullable":true},"interoadsProvisionedExamUrl":{"type":"string","description":"Interroads provisioned exam URL","nullable":true},"proctorGroupSid":{"type":"string","description":"Proctor group SID","nullable":true},"mandatoryRoomScanVideo":{"type":"boolean","description":"Mandatory room scan video","nullable":true},"mutedAnnotations":{"type":"string","description":"Muted annotations","nullable":true},"browserExtensionVersion":{"type":"string","description":"Browser extension the session was started with","nullable":true}}},"ExamConfigurationListItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"examSid":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"examOpenDate":{"type":"string","nullable":true},"examCloseDate":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true}}},"Model30":{"type":"array","description":"Exam configuration records","items":{"$ref":"#/components/schemas/ExamConfigurationListItem"}},"ExamConfigurationListResponse":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"first":{"type":"string","description":"URL for first page","nullable":true},"next":{"type":"string","description":"URL for next page","nullable":true},"prev":{"type":"string","description":"URL for previous page","nullable":true},"last":{"type":"string","description":"URL for last page","nullable":true},"count":{"type":"number","description":"Number of results in this page"},"offset":{"type":"number","description":"Current offset"},"results":{"$ref":"#/components/schemas/Model30"}}},"ExamSessionListItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"sessionType":{"type":"string","nullable":true},"appointmentDate":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"editDate":{"type":"string","nullable":true}}},"Model31":{"type":"array","description":"Exam session records","items":{"$ref":"#/components/schemas/ExamSessionListItem"}},"ExamSessionListResponse":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"first":{"type":"string","description":"URL for first page","nullable":true},"next":{"type":"string","description":"URL for next page","nullable":true},"prev":{"type":"string","description":"URL for previous page","nullable":true},"last":{"type":"string","description":"URL for last page","nullable":true},"count":{"type":"number","description":"Number of results in this page"},"offset":{"type":"number","description":"Current offset"},"results":{"$ref":"#/components/schemas/Model31"}}},"ExamSessionEventReportListItem":{"type":"object","properties":{"sid":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true}}},"Model32":{"type":"array","description":"Event report records","items":{"$ref":"#/components/schemas/ExamSessionEventReportListItem"}},"ExamSessionEventReportListResponse":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"first":{"type":"string","description":"URL for first page","nullable":true},"next":{"type":"string","description":"URL for next page","nullable":true},"prev":{"type":"string","description":"URL for previous page","nullable":true},"last":{"type":"string","description":"URL for last page","nullable":true},"count":{"type":"number","description":"Number of results in this page"},"offset":{"type":"number","description":"Current offset"},"results":{"$ref":"#/components/schemas/Model32"}}},"ExamSessionEventReportResponse":{"type":"object","properties":{"sid":{"type":"string","description":"Event report SID","nullable":true},"contactPerson":{"type":"string","description":"Contact person","nullable":true},"contactPhone":{"type":"string","description":"Contact phone","nullable":true},"contactEmail":{"type":"string","description":"Contact email","nullable":true},"correctiveActionDetails":{"type":"string","description":"Corrective action details","nullable":true},"details":{"type":"string","description":"Details","nullable":true},"directWitness":{"type":"string","description":"Direct witness","nullable":true},"draft":{"type":"boolean","description":"Draft","nullable":true},"eventTime":{"type":"string","description":"Event time","nullable":true},"examSessionSid":{"type":"string","description":"Exam session SID","nullable":true},"potentialDamage":{"type":"string","description":"Potential damage","nullable":true},"subject":{"type":"string","description":"Subject","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"createdDate":{"type":"string","description":"Created date","nullable":true},"eventType":{"type":"string","description":"Event type","nullable":true}}},"Model33":{"type":"array","description":"Proctor types","nullable":true,"items":{"type":"string"}},"Model34":{"type":"array","description":"Instructor as proctor","nullable":true,"items":{"type":"string"}},"ExamConfigurationResponse":{"type":"object","properties":{"sid":{"type":"string","description":"Configuration SID","nullable":true},"examSid":{"type":"string","description":"Exam SID","nullable":true},"enrollmentSid":{"type":"string","description":"Enrollment SID","nullable":true},"referenceExamConfigurationSid":{"type":"string","description":"Reference exam configuration SID","nullable":true},"type":{"type":"string","description":"Configuration type","nullable":true},"examOpenDate":{"type":"string","description":"Exam open date","nullable":true},"examCloseDate":{"type":"string","description":"Exam close date","nullable":true},"scheduleOpenDate":{"type":"string","description":"Schedule open date","nullable":true},"scheduleCloseDate":{"type":"string","description":"Schedule close date","nullable":true},"password":{"type":"string","description":"Exam password","nullable":true},"url":{"type":"string","description":"Exam URL","nullable":true},"duration":{"type":"number","description":"Duration in minutes","nullable":true},"attempts":{"type":"number","description":"Number of attempts","nullable":true},"attemptsRemaining":{"type":"number","description":"Attempts remaining","nullable":true},"locked":{"type":"boolean","description":"Whether locked","nullable":true},"approved":{"type":"boolean","description":"Whether approved","nullable":true},"approvedBy":{"type":"string","description":"Approved by","nullable":true},"requiredSoftware":{"type":"string","description":"Required software","nullable":true},"studentNotes":{"type":"string","description":"Student notes","nullable":true},"permittedBathroomBreak":{"type":"boolean","description":"Bathroom break permitted","nullable":true},"permittedBathroomBreakInformation":{"type":"string","description":"Bathroom break info","nullable":true},"permittedBlankPaper":{"type":"boolean","description":"Blank paper permitted","nullable":true},"permittedBlankPaperInformation":{"type":"string","description":"Blank paper info","nullable":true},"permittedCalculator":{"type":"boolean","description":"Calculator permitted","nullable":true},"permittedCalculatorInformation":{"type":"string","description":"Calculator info","nullable":true},"permittedDictionary":{"type":"boolean","description":"Dictionary permitted","nullable":true},"permittedDictionaryInformation":{"type":"string","description":"Dictionary info","nullable":true},"permittedEarplugs":{"type":"boolean","description":"Earplugs permitted","nullable":true},"permittedEarplugsInformation":{"type":"string","description":"Earplugs info","nullable":true},"permittedFormulaSheet":{"type":"boolean","description":"Formula sheet permitted","nullable":true},"permittedFormulaSheetInformation":{"type":"string","description":"Formula sheet info","nullable":true},"permittedNotes":{"type":"boolean","description":"Notes permitted","nullable":true},"permittedNotesInformation":{"type":"string","description":"Notes info","nullable":true},"permittedOtherItems":{"type":"string","description":"Other permitted items","nullable":true},"permittedTextbook":{"type":"boolean","description":"Textbook permitted","nullable":true},"permittedTextbookInformation":{"type":"string","description":"Textbook info","nullable":true},"permittedWebsites":{"type":"boolean","description":"Websites permitted","nullable":true},"permittedWebsitesInformation":{"type":"string","description":"Websites info","nullable":true},"apiExamId":{"type":"string","description":"API exam ID","nullable":true},"examSyncStatus":{"type":"string","description":"Exam sync status","nullable":true},"virtualCalculatorType":{"type":"string","description":"Virtual calculator type","nullable":true},"synchronization":{"type":"string","description":"Synchronization info","nullable":true},"proctorNotes":{"type":"string","description":"Proctor notes","nullable":true},"proctorTypes":{"$ref":"#/components/schemas/Model33"},"attachments":{"type":"string","description":"Attachments","nullable":true},"examFiles":{"type":"string","description":"Exam files","nullable":true},"instructorAsProctor":{"$ref":"#/components/schemas/Model34"},"exam":{"type":"string","description":"Associated exam","nullable":true},"course":{"type":"string","description":"Associated course","nullable":true},"enrollment":{"type":"string","description":"Associated enrollment","nullable":true},"createdDate":{"type":"string","description":"Created date","nullable":true},"editDate":{"type":"string","description":"Last modified date","nullable":true},"instructor":{"type":"string","description":"Instructor details","nullable":true},"modalityOptions":{"type":"string","description":"Modality options","nullable":true},"allowedSites":{"type":"string","description":"Allowed sites document","nullable":true},"allowedSitesInheritance":{"type":"string","description":"Allowed sites inheritance","nullable":true},"updatedAutomatedSessions":{"type":"string","description":"Updated automated sessions","nullable":true}}},"CourseOffering":{"type":"object","description":"Payload for creating a new course offering","properties":{"title":{"type":"string","description":"Human-readable title for the course offering (e.g., semester or term name).","example":"Fall 2024"},"matchStrings":{"type":"string","description":"Comma-separated list of text patterns used to automatically match incoming LMS courses to this offering.","example":"Fall 2024,FA24"},"startDate":{"type":"string","description":"Start Date","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"endDate":{"type":"string","description":"End Date","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["title","matchStrings"]},"User":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name"},"lastName":{"type":"string","description":"Last Name"},"email":{"type":"string","description":"Email","x-format":{"email":true}},"preferredEmail":{"type":"string","description":"Preferred Email","x-format":{"email":true}},"homePhone":{"type":"string","description":"Home Phone","nullable":true},"mobilePhone":{"type":"string","description":"Mobile Phone","nullable":true},"currencyCode":{"type":"string","description":"Currency code","x-constraint":{"length":3}},"timeZoneSid":{"type":"string","description":"Time Zone Sid","pattern":"^TZ[a-f0-9]{32}$"},"latitude":{"type":"number","description":"Location Latitude","nullable":true},"longitude":{"type":"number","description":"Location Longitude","nullable":true},"username":{"type":"string","description":"Username for user"},"password":{"type":"string","description":"Password for user","pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[#$@!%&*?])[A-Za-z\\d#$@!%&*?]{8,30}$"},"enabled":{"type":"boolean","description":"If login as this user is enabled"},"lmsId":{"type":"string","description":"The id for the user as defined in the LMS as defined in the LTI launch.","nullable":true},"sisId":{"type":"string","description":"The id for the user as defined in the SIS.","nullable":true},"exernalId":{"type":"string","description":"The id for the user as defined in any external system for tracking.","nullable":true}},"required":["firstName","lastName","email"]},"ids":{"type":"object","description":"Contains course identifiers; only one ID type is allowed.","properties":{"sid":{"type":"string","pattern":"^CU[a-z0-9]{32}$"},"api":{"type":"string"},"lms":{"type":"string"},"external":{"type":"string"}}},"ProvisionCourse":{"type":"object","description":"Course data","properties":{"ids":{"$ref":"#/components/schemas/ids"},"title":{"description":"Required if `sid` is NOT provided.","required":["title"],"anyOf":[{"type":"string"},{"type":"string"}]},"code":{"description":"Required if `sid` is NOT provided.","anyOf":[{"type":"string","nullable":true},{"type":"string","nullable":true}]}},"required":["ids"]},"Model35":{"type":"object","description":"Contains user identifiers; only one ID type is allowed.","properties":{"sid":{"type":"string","pattern":"^US[a-z0-9]{32}$"},"api":{"type":"string"},"lms":{"type":"string"},"external":{"type":"string"}}},"ProvisionUser":{"type":"object","properties":{"ids":{"$ref":"#/components/schemas/Model35"},"firstName":{"description":"Required if `sid` is NOT provided.","required":["firstName"],"anyOf":[{"type":"string"},{"type":"string"}]},"lastName":{"description":"Required if `sid` is NOT provided.","required":["lastName"],"anyOf":[{"type":"string"},{"type":"string"}]},"email":{"description":"Must be a valid email. Required if `sid` is NOT provided.","required":["email"],"anyOf":[{"type":"string","x-format":{"email":true}},{"type":"string","x-format":{"email":true}}]},"currencyCode":{"type":"string","description":"Currency code for the user, if not passed, will default to the currency set on the account.","nullable":true},"timeZone":{"type":"string","description":"Time zone of the user, if not passed, will default to the timezone set on the account.","nullable":true}},"required":["ids"]},"Model36":{"type":"object","description":"Exam IDs must contain either \"sid\" (EX+32 chars) or \"external\" (string).","properties":{"sid":{"type":"string","pattern":"^EX[a-z0-9]{32}$"},"external":{"type":"string"}}},"type":{"type":"string","default":"online","enum":["online","written"]},"Model37":{"type":"string","default":"primary","enum":["primary","accommodation"]},"access":{"type":"object","description":"Defines access times for the exam.","properties":{"open":{"type":"string","x-format":{"isoDate":true}},"close":{"type":"string","x-format":{"isoDate":true}}},"required":["open","close"]},"scheduling":{"type":"object","description":"Defines optional scheduling times.","properties":{"open":{"type":"string","x-format":{"isoDate":true}},"close":{"type":"string","x-format":{"isoDate":true}}}},"notes":{"type":"object","properties":{"student":{"type":"string"},"proctor":{"type":"string"}}},"Model38":{"type":"object","description":"Proctoring options. TS+32 character ID keys. Options are optional but required for virtual settings."},"permittedItems":{"type":"object","description":"Optional permitted items with notes."},"Model39":{"type":"object","description":"Configuration for the exam. Optional unless IDs are required.","properties":{"ids":{"type":"string"},"type":{"$ref":"#/components/schemas/Model37"},"url":{"type":"string"},"access":{"$ref":"#/components/schemas/access"},"scheduling":{"$ref":"#/components/schemas/scheduling"},"duration":{"type":"integer","description":"Duration in minutes.","x-constraint":{"sign":"positive"}},"password":{"type":"string"},"attempts":{"type":"integer","default":1,"x-constraint":{"sign":"positive"}},"notes":{"$ref":"#/components/schemas/notes"},"proctorTypes":{"$ref":"#/components/schemas/Model38"},"permittedItems":{"$ref":"#/components/schemas/permittedItems"}},"required":["url","access","duration","password","proctorTypes"]},"ProvisionExam":{"type":"object","description":"Exam schema ensuring required and optional fields meet validation criteria.","properties":{"ids":{"$ref":"#/components/schemas/Model36"},"title":{"description":"Title is required if ids.sid is not provided.","required":["title"],"anyOf":[{"type":"string"},{"type":"string"}]},"description":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/type"},"practice":{"type":"boolean","default":false},"limitedScope":{"type":"boolean","default":false},"deliverySystem":{"type":"string","description":"Must be validated against available systems.","nullable":true},"configuration":{"$ref":"#/components/schemas/Model39"}},"required":["ids"]},"ProvisionSignon":{"type":"object","description":"Optional signon object.. If provided, integrationSid must be present. This will return the signon information to redirect the user to.","properties":{"integrationSid":{"type":"string","description":"Required if signon is provided. Must start with \"II\" and be a 32-character alphanumeric string.","pattern":"^II[a-fA-F0-9]{32}$"}},"required":["integrationSid"]},"Model40":{"type":"object","properties":{"course":{"$ref":"#/components/schemas/ProvisionCourse"},"user":{"$ref":"#/components/schemas/ProvisionUser"},"enrollment":{"description":"Enrollment object is optional but can only exist if `user` is provided.","anyOf":[{"$ref":"#/x-alt-definitions/ProvisionEnrollment"}]},"exam":{"$ref":"#/components/schemas/ProvisionExam"},"signon":{"$ref":"#/components/schemas/ProvisionSignon"}},"required":["course"]},"Model41":{"type":"string","description":"Exam type. `Online` for web-based exams (requires URL and password), `Written` for paper-based exams.","example":"Online","enum":["Online","Written"]},"timeType":{"type":"string","description":"Time Type","enum":["between","at"]},"Model42":{"type":"object","description":"Exam Configuration Instructor Proctor payload","properties":{"location":{"type":"string","description":"Location"},"timeType":{"$ref":"#/components/schemas/timeType"},"startTime":{"type":"string","description":"Start Time","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"End Time"},"capacity":{"type":"number","description":"Capacity","nullable":true}},"required":["location","timeType","startTime","endTime"]},"Model43":{"type":"array","description":"List of Instructor as Proctor","items":{"$ref":"#/components/schemas/Model42"}},"Model44":{"type":"array","description":"Types of proctor for exam","minItems":1,"items":{"type":"string","pattern":"^TS[a-f0-9]{32}$"}},"modalityOptions":{"type":"object","description":"List of modality options","default":{}},"virtualCalculatorType":{"type":"string","description":"Calculator for student to use","example":"scientific-calc","enum":["scientific-calc","graphing-calc","matrix-calc","four-function-calc"],"nullable":true},"match":{"type":"string","description":"How the URL is compared: exact, prefix, host or domain. Defaults to prefix when the URL has a path, otherwise host","example":"prefix","enum":["exact","prefix","host","domain"]},"Model45":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an existing rule, generated when it is left out","maxLength":64},"label":{"type":"string","description":"A human readable name for the site","example":"Cengage SALT","nullable":true,"maxLength":120},"url":{"type":"string","description":"The URL to allow, or the pattern when the match type is regex","example":"https://www.webassign.net/csalt/","maxLength":2048},"match":{"$ref":"#/components/schemas/match"},"includeSubdomains":{"type":"boolean","description":"Whether subdomains of the host are allowed as well","default":false},"enabled":{"type":"boolean","description":"Whether the rule is currently in effect","default":true}},"required":["url"]},"ExamAllowedSites":{"type":"array","description":"Sites students may open in a new tab while new tabs are disabled","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/Model45"}},"allowedSitesInheritance":{"type":"string","description":"Whether the exam adds to the sites allowed by the install and the exam delivery system, or uses only its own","example":"inherit","enum":["inherit","override"]},"Model46":{"type":"object","properties":{"instructorAsProctor":{"$ref":"#/components/schemas/Model43"},"examOpenDate":{"type":"string","description":"Exam Open Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"examCloseDate":{"type":"string","description":"Exam Close Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"scheduleOpenDate":{"type":"string","description":"Schedule Open Date","example":"1970-01-01T00:00:00.000Z","default":"2000-01-01","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"scheduleCloseDate":{"type":"string","description":"Schedule Close Date","example":"1970-01-01T00:00:00.000Z","default":"2070-01-01","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"password":{"type":"string","description":"Password"},"duration":{"type":"integer","description":"Duration Minutes","maximum":480,"x-constraint":{"sign":"positive"}},"attempts":{"type":"integer","description":"Attempts Allowed","x-constraint":{"sign":"positive"}},"requiredSoftware":{"type":"string","description":"Required Software","nullable":true},"studentNotes":{"type":"string","description":"Student Notes","nullable":true},"permittedBathroomBreak":{"type":"boolean","description":"Is Bathroom Break permitted"},"permittedBathroomBreakInformation":{"type":"string","description":"Additional Information about bathroom break","nullable":true},"permittedBlankPaper":{"type":"boolean","description":"Is blank paper permitted"},"permittedBlankPaperInformation":{"type":"string","description":"Additional Information about blank paper","nullable":true},"permittedCalculator":{"type":"boolean","description":"Is calculator permitted"},"permittedCalculatorInformation":{"type":"string","description":"Additional Information about calculator","nullable":true},"permittedDictionary":{"type":"boolean","description":"Is Dictionary permitted"},"permittedDictionaryInformation":{"type":"string","description":"Additional Information about Dictionary","nullable":true},"permittedEarplugs":{"type":"boolean","description":"Is Earplugs permitted"},"permittedEarplugsInformation":{"type":"string","description":"Additional Information about Earplugs","nullable":true},"permittedFormulaSheet":{"type":"boolean","description":"Is FormulaSheet permitted"},"permittedFormulaSheetInformation":{"type":"string","description":"Additional Information about FormulaSheet","nullable":true},"permittedNotes":{"type":"boolean","description":"Is Notes permitted"},"permittedNotesInformation":{"type":"string","description":"Additional Information about Notes","nullable":true},"permittedOtherItems":{"type":"string","description":"Other permitted Items","nullable":true},"permittedTextbook":{"type":"boolean","description":"Is Textbook permitted"},"permittedTextbookInformation":{"type":"string","description":"Additional Information about Textbook","nullable":true},"permittedWebsites":{"type":"boolean","description":"Is Websites permitted"},"permittedWebsitesInformation":{"type":"string","description":"Additional Information about Websites","nullable":true},"proctorNotes":{"type":"string","description":"Proctor Notes","nullable":true},"proctorTypes":{"$ref":"#/components/schemas/Model44"},"apiExamId":{"type":"string","description":"API exam ID","nullable":true},"modalityOptions":{"$ref":"#/components/schemas/modalityOptions"},"virtualCalculatorType":{"$ref":"#/components/schemas/virtualCalculatorType"},"allowedSites":{"$ref":"#/components/schemas/ExamAllowedSites"},"allowedSitesInheritance":{"$ref":"#/components/schemas/allowedSitesInheritance"}},"required":["instructorAsProctor","examOpenDate","examCloseDate","password","duration","attempts","requiredSoftware","studentNotes","permittedBathroomBreak","permittedBathroomBreakInformation","permittedBlankPaper","permittedBlankPaperInformation","permittedCalculator","permittedCalculatorInformation","permittedDictionary","permittedDictionaryInformation","permittedEarplugs","permittedEarplugsInformation","permittedFormulaSheet","permittedFormulaSheetInformation","permittedNotes","permittedNotesInformation","permittedOtherItems","permittedTextbook","permittedTextbookInformation","permittedWebsites","permittedWebsitesInformation","proctorNotes","proctorTypes"]},"status":{"type":"string","description":"Status of the exam. `active` exams are visible to students, `draft` are in preparation, `deleted` are soft-deleted.","example":"active","default":"active","enum":["active","draft","deleted"]},"Exam":{"type":"object","description":"Payload for creating a new exam with full configuration.","properties":{"title":{"type":"string","description":"Display title for the exam.","example":"Midterm Exam 1"},"type":{"$ref":"#/components/schemas/Model41"},"description":{"type":"string","description":"Optional description providing additional details about the exam.","example":"Covers chapters 1-5","nullable":true},"useProctorManager":{"type":"boolean","description":"Whether to use the proctor manager for automated proctor assignment.","example":true},"requireApproval":{"type":"boolean","description":"Whether exam sessions require manual approval before the student can begin.","example":false},"url":{"type":"string","description":"Exam URL"},"enableAppointmentSuggestions":{"type":"boolean","description":"Whether to show suggested appointment time slots to students during scheduling.","example":true},"examDeliverySystemModule":{"type":"string","description":"Identifier for the exam delivery system module (e.g., LMS integration module name). Optional field controlled by feature flag.","example":"canvas","nullable":true},"contactUserSid":{"type":"string","description":"SID of the user to contact for exam-related issues. Pattern: `US` + 32 hex chars.","example":"US1234567890abcdef1234567890abcdef","nullable":true,"pattern":"^US[a-f0-9]{32}$"},"isLimitedScope":{"type":"boolean","description":"When true, the exam is assigned to specific students only. When false, all enrolled students can take the exam.","example":false,"default":false},"configuration":{"$ref":"#/components/schemas/Model46"},"status":{"$ref":"#/components/schemas/status"}},"required":["title","type","useProctorManager","requireApproval","url","enableAppointmentSuggestions","configuration"]},"Model47":{"type":"string","description":"Session type","enum":["b-virtual","ad-hoc","instructor-as-proctor","messaging","register-blast","vtc","proctoru","examity","smarter-scheduling","automated"]},"ScheduleSession":{"type":"object","description":"The exam session schedule payload","properties":{"type":{"$ref":"#/components/schemas/Model47"},"notes":{"type":"string","description":"Notes regarding session"},"proctorLocationSid":{"type":"string","description":"The proctor location that is being scheduled for","pattern":"^PL[a-f0-9]{32}$"},"messageSid":{"type":"string","description":"The Message Thread that is being scheduled for","pattern":"^MT[a-f0-9]{32}$"},"currency":{"type":"string","description":"The 3 digit currency code","x-constraint":{"length":3}},"amount":{"type":"number","description":"The amount the session costs in the currency that was provided","minimum":0},"cardToken":{"type":"string","description":"The Stripe token"},"voucherCode":{"type":"string","description":"If a voucher code is to be used for this transaction"},"company":{"type":"string","description":"The company name of the proctor"},"firstName":{"type":"string","description":"The first name of the proctor or testing center contact"},"lastName":{"type":"string","description":"The last name of the proctor or testing center contact"},"email":{"type":"string","description":"The email address of the proctor or testing center contact","x-format":{"email":true}},"phone":{"type":"string","description":"The phone number of the proctor or testing center contact"},"address1":{"type":"string","description":"Ad-hoc proctor address line 1"},"address2":{"type":"string","description":"Ad-hoc proctor address line 2"},"place":{"type":"string","description":"Ad-hoc proctor place"},"region":{"type":"string","description":"Ad-hoc proctor region"},"country":{"type":"string","description":"Ad-hoc proctor country"},"locationLatitude":{"type":"string","description":"Ad-hoc proctor location latitude"},"locationLongitude":{"type":"string","description":"Ad-hoc proctor location longitude"},"postalCode":{"type":"string","description":"Ad-hoc proctor postal code"},"appointmentDateTime":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"instructorProctorSid":{"type":"string","description":"instructor as proctor sid","pattern":"^CP[a-f0-9]{32}$"},"externalAppointmentId":{"type":"string","description":"External appointmentId for registarblast"},"cancellationPolicyVersionSid":{"type":"string","description":"If a cancellationPolicyVersionSid is to be used for this session","pattern":"^CV[a-f0-9]{32}$"},"examLocale":{"type":"string","description":"Locale of the exam","nullable":true},"proctorTypeSubCategorySid":{"type":"string","description":"The proctor type that is being scheduled.","pattern":"^TS[a-f0-9]{32}$"}}},"Model48":{"type":"string","description":"Status","enum":["Open","Closed"]},"ExamSessionEventReport":{"type":"object","description":"Exam Session Event Report payload","properties":{"subject":{"type":"string","description":"Subject"},"details":{"type":"string","description":"Details","nullable":true},"status":{"$ref":"#/components/schemas/Model48"},"eventTime":{"type":"string","description":"Event Time","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"potentialDamage":{"type":"string","description":"Potential Damage","nullable":true},"correctiveActionDetails":{"type":"string","description":"Corrective Action Details","nullable":true},"directWitness":{"type":"string","description":"Direct Witness"},"contactPerson":{"type":"string","description":"Contact Person"},"contactPhone":{"type":"string","description":"Contact Phone"},"contactEmail":{"type":"string","description":"Contact Email","x-format":{"email":true}},"eventTypeSid":{"type":"string","description":"Exam session event type","pattern":"^ET[a-f0-9]{32}$"},"draft":{"type":"boolean","description":"Draft"}},"required":["subject","status","eventTime","directWitness","contactPerson","contactPhone","contactEmail","draft"]},"Model49":{"type":"string","description":"Session type","enum":["b-virtual","ad-hoc","instructor-as-proctor","messaging","proctoru","register-blast","vtc","examity","smarter-scheduling","automated"]},"reason":{"type":"string","description":"Reason for closing","enum":["exam-completed","technical-issue","other-reason"]},"CloseSession":{"type":"object","description":"Exam session close payload","properties":{"type":{"$ref":"#/components/schemas/Model49"},"reason":{"$ref":"#/components/schemas/reason"}},"required":["type","reason"]},"Model50":{"type":"object","description":"Exam Configuration Instructor Proctor payload","properties":{"location":{"type":"string","description":"Location"},"timeType":{"$ref":"#/components/schemas/timeType"},"startTime":{"type":"string","description":"Start Time","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"End Time"},"capacity":{"type":"number","description":"Capacity","nullable":true}},"required":["location","timeType","startTime","endTime"]},"Model51":{"type":"array","description":"List of Instructor as Proctor","items":{"$ref":"#/components/schemas/Model50"}},"Model52":{"type":"array","description":"Types of proctor for exam","items":{"type":"string","pattern":"^TS[a-f0-9]{32}$"}},"Model53":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an existing rule, generated when it is left out","maxLength":64},"label":{"type":"string","description":"A human readable name for the site","example":"Cengage SALT","nullable":true,"maxLength":120},"url":{"type":"string","description":"The URL to allow, or the pattern when the match type is regex","example":"https://www.webassign.net/csalt/","maxLength":2048},"match":{"$ref":"#/components/schemas/match"},"includeSubdomains":{"type":"boolean","description":"Whether subdomains of the host are allowed as well","default":false},"enabled":{"type":"boolean","description":"Whether the rule is currently in effect","default":true}},"required":["url"]},"ExamConfigurationAllowedSites":{"type":"array","description":"Sites students may open in a new tab while new tabs are disabled","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/Model53"}},"ExamConfiguration":{"type":"object","description":"Exam Configuration payload","properties":{"instructorAsProctor":{"$ref":"#/components/schemas/Model51"},"examOpenDate":{"type":"string","description":"Exam Open Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"examCloseDate":{"type":"string","description":"Exam Close Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"scheduleOpenDate":{"type":"string","description":"Schedule Open Date","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"scheduleCloseDate":{"type":"string","description":"Schedule Close Date","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"enrollmentSid":{"type":"string","description":"Enrollment sid","pattern":"^EN[a-f0-9]{32}$"},"url":{"type":"string","description":"Exam Url","nullable":true},"password":{"type":"string","description":"Password"},"duration":{"type":"integer","description":"Duration Minutes","x-constraint":{"sign":"positive"}},"attempts":{"type":"integer","description":"Attempts Allowed","x-constraint":{"sign":"positive"}},"requiredSoftware":{"type":"string","description":"Required Software","nullable":true},"studentNotes":{"type":"string","description":"Student Notes","nullable":true},"virtualCalculatorType":{"type":"string","description":"Virtual Calculator Type","nullable":true},"permittedBathroomBreak":{"type":"boolean","description":"Is Bathroom Break permitted"},"permittedBathroomBreakInformation":{"type":"string","description":"Additional Information about bathroom break","nullable":true},"permittedBlankPaper":{"type":"boolean","description":"Is blank paper permitted"},"permittedBlankPaperInformation":{"type":"string","description":"Additional Information about blank paper","nullable":true},"permittedCalculator":{"type":"boolean","description":"Is calculator permitted"},"permittedCalculatorInformation":{"type":"string","description":"Additional Information about calculator","nullable":true},"permittedDictionary":{"type":"boolean","description":"Is Dictionary permitted"},"permittedDictionaryInformation":{"type":"string","description":"Additional Information about Dictionary","nullable":true},"permittedEarplugs":{"type":"boolean","description":"Is Earplugs permitted"},"permittedEarplugsInformation":{"type":"string","description":"Additional Information about Earplugs","nullable":true},"permittedFormulaSheet":{"type":"boolean","description":"Is FormulaSheet permitted"},"permittedFormulaSheetInformation":{"type":"string","description":"Additional Information about FormulaSheet","nullable":true},"permittedNotes":{"type":"boolean","description":"Is Notes permitted"},"permittedNotesInformation":{"type":"string","description":"Additional Information about Notes","nullable":true},"permittedOtherItems":{"type":"string","description":"Other permitted Items","nullable":true},"permittedTextbook":{"type":"boolean","description":"Is Textbook permitted"},"permittedTextbookInformation":{"type":"string","description":"Additional Information about Textbook","nullable":true},"permittedWebsites":{"type":"boolean","description":"Is Websites permitted"},"permittedWebsitesInformation":{"type":"string","description":"Additional Information about Websites","nullable":true},"proctorNotes":{"type":"string","description":"Proctor Notes","nullable":true},"proctorTypes":{"$ref":"#/components/schemas/Model52"},"referenceExamConfigurationSid":{"type":"string","description":"referenceExamConfigurationSid","nullable":true,"pattern":"^EC[a-f0-9]{32}$"},"modalityOptions":{"$ref":"#/components/schemas/modalityOptions"},"allowedSites":{"$ref":"#/components/schemas/ExamConfigurationAllowedSites"},"allowedSitesInheritance":{"$ref":"#/components/schemas/allowedSitesInheritance"}},"required":["instructorAsProctor","examOpenDate","examCloseDate","duration","attempts","requiredSoftware","studentNotes","permittedBathroomBreak","permittedBathroomBreakInformation","permittedBlankPaper","permittedBlankPaperInformation","permittedCalculator","permittedCalculatorInformation","permittedDictionary","permittedDictionaryInformation","permittedEarplugs","permittedEarplugsInformation","permittedFormulaSheet","permittedFormulaSheetInformation","permittedNotes","permittedNotesInformation","permittedOtherItems","permittedTextbook","permittedTextbookInformation","permittedWebsites","permittedWebsitesInformation","proctorNotes"]},"AdminUserUpdate":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name"},"lastName":{"type":"string","description":"Last Name"},"email":{"type":"string","description":"Email","x-format":{"email":true}},"preferredEmail":{"type":"string","description":"Preferred Email","x-format":{"email":true}},"homePhone":{"type":"string","description":"Home Phone","nullable":true},"mobilePhone":{"type":"string","description":"Mobile Phone","nullable":true},"currencyCode":{"type":"string","description":"Currency code","x-constraint":{"length":3}},"timeZoneSid":{"type":"string","description":"Time Zone Sid","pattern":"^TZ[a-f0-9]{32}$"},"username":{"type":"string","description":"Username for user"},"password":{"type":"string","description":"Password for user","pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[#$@!%&*?])[A-Za-z\\d#$@!%&*?]{8,30}$"},"enabled":{"type":"boolean","description":"If login as this user is enabled"}}},"CourseOfferingUpdate":{"type":"object","description":"Update course offering payload","properties":{"title":{"type":"string","description":"Human-readable title for the course offering.","example":"Fall 2024"},"matchStrings":{"type":"string","description":"Comma-separated list of text patterns used to automatically match incoming LMS courses to this offering.","example":"Fall 2024,FA24"},"startDate":{"type":"string","description":"Start Date","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"endDate":{"type":"string","description":"End Date","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["title","matchStrings"]},"enrollmentSids":{"type":"array","description":"Enrollment SIDs to assign to this assignment.","maxItems":100,"items":{"type":"string","pattern":"^EN[a-f0-9]{32}$"}},"sectionSids":{"type":"array","description":"Section SIDs to assign to this assignment.","maxItems":100,"items":{"type":"string","pattern":"^CS[a-f0-9]{32}$"}},"targets":{"type":"object","description":"Targets for the new assignment.","properties":{"enrollmentSids":{"$ref":"#/components/schemas/enrollmentSids"},"sectionSids":{"$ref":"#/components/schemas/sectionSids"}}},"Model54":{"type":"object","properties":{"examOpenDate":{"type":"string","format":"date","description":"When the exam opens for taking.","nullable":true},"examCloseDate":{"type":"string","format":"date","description":"When the exam closes for taking.","nullable":true},"schedulingOpenDate":{"type":"string","format":"date","description":"When scheduling opens.","nullable":true},"schedulingCloseDate":{"type":"string","format":"date","description":"When scheduling closes.","nullable":true},"targets":{"$ref":"#/components/schemas/targets"}}},"added":{"type":"array","description":"Array of new assignments to create.","items":{"$ref":"#/components/schemas/Model54"}},"removed":{"type":"array","description":"Array of assignment SIDs to delete.","items":{"type":"string","example":"EA1234567890abcdef1234567890abcdef","pattern":"^EA[a-f0-9]{32}$"}},"Model55":{"type":"array","description":"Enrollment SIDs to add to this assignment.","maxItems":100,"items":{"type":"string","pattern":"^EN[a-f0-9]{32}$"}},"Model56":{"type":"array","description":"Section SIDs to add to this assignment.","maxItems":100,"items":{"type":"string","pattern":"^CS[a-f0-9]{32}$"}},"Model57":{"type":"object","description":"Targets to add.","properties":{"enrollmentSids":{"$ref":"#/components/schemas/Model55"},"sectionSids":{"$ref":"#/components/schemas/Model56"}}},"Model58":{"type":"array","description":"Enrollment SIDs to remove from this assignment.","maxItems":100,"items":{"type":"string","pattern":"^EN[a-f0-9]{32}$"}},"Model59":{"type":"array","description":"Section SIDs to remove from this assignment.","maxItems":100,"items":{"type":"string","pattern":"^CS[a-f0-9]{32}$"}},"Model60":{"type":"object","description":"Targets to remove.","properties":{"enrollmentSids":{"$ref":"#/components/schemas/Model58"},"sectionSids":{"$ref":"#/components/schemas/Model59"}}},"Model61":{"type":"object","description":"Target mutations for this assignment.","properties":{"added":{"$ref":"#/components/schemas/Model57"},"removed":{"$ref":"#/components/schemas/Model60"}}},"Model62":{"type":"object","properties":{"sid":{"type":"string","description":"SID of the assignment to update.","example":"EA1234567890abcdef1234567890abcdef","pattern":"^EA[a-f0-9]{32}$"},"examOpenDate":{"type":"string","format":"date","description":"Updated exam open date.","nullable":true},"examCloseDate":{"type":"string","format":"date","description":"Updated exam close date.","nullable":true},"schedulingOpenDate":{"type":"string","format":"date","description":"Updated scheduling open date.","nullable":true},"schedulingCloseDate":{"type":"string","format":"date","description":"Updated scheduling close date.","nullable":true},"targets":{"$ref":"#/components/schemas/Model61"}},"required":["sid"]},"updated":{"type":"array","description":"Array of existing assignments to update.","items":{"$ref":"#/components/schemas/Model62"}},"UpdateExamAssignment":{"type":"object","description":"Payload for adding, removing, or updating exam assignments.","properties":{"added":{"$ref":"#/components/schemas/added"},"removed":{"$ref":"#/components/schemas/removed"},"updated":{"$ref":"#/components/schemas/updated"}}},"UserProfile":{"type":"object","description":"Update user Profile payload","properties":{"currencyCode":{"type":"string","description":"Currency Code","x-constraint":{"length":3}},"timeZoneSid":{"type":"string","description":"Time Zone Sid","pattern":"^TZ[a-f0-9]{32}$"},"maxTravelDistanceUnits":{"type":"string","description":"Max Travel Distance Units"},"mobilePhone":{"type":"string","description":"Mobile Phone","nullable":true},"preferredEmail":{"type":"string","description":"Preferred Email","x-format":{"email":true}},"latitude":{"type":"number","description":"Location Latitude","nullable":true},"longitude":{"type":"number","description":"Location Longitude","nullable":true},"maxTravelDistance":{"type":"number","description":"Max Travel Distance","nullable":true},"homePhone":{"type":"string","description":"Home Phone","nullable":true},"address":{"type":"string","description":"Address","nullable":true},"smarterId":{"type":"string","description":"SmarterID ID","pattern":"^IU[a-f0-9]{32}$"},"smarterIdEnrollmentSid":{"type":"string","description":"SmarterID EnrollmentSid","pattern":"^IE[a-f0-9]{32}$"}},"required":["currencyCode","timeZoneSid","maxTravelDistanceUnits"]},"Model63":{"type":"string","description":"Type of the system","enum":["b-virtual","ad-hoc","register-blast","proctoru","examity","smarter-scheduling"]},"RescheduleSession":{"type":"object","description":"Exam session reserve payload","properties":{"type":{"$ref":"#/components/schemas/Model63"},"notes":{"type":"string","description":"Notes regarding session"},"appointmentStartDateTime":{"type":"string","description":"The GMT timestamp when the session is to be started","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"appointmentEndDateTime":{"type":"string","description":"The GMT timestamp when the session is to be end","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"company":{"type":"string","description":"The company of the proctor, maps to proctor_company__c"},"firstName":{"type":"string","description":"The first name of the proctor, maps to proctor_first_name__c"},"lastName":{"type":"string","description":"The last name of the proctor, maps to proctor_last_name__c"},"email":{"type":"string","description":"The email address of the proctor, maps to proctor_email__c","x-format":{"email":true}},"phone":{"type":"string","description":"The phone number for the proctor, maps to proctor_phone__c"},"appointmentDateTime":{"type":"string","description":"The appointment date/time. maps to appointment_date__c","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"address1":{"type":"string","description":"Ad-hoc proctor address line 1"},"address2":{"type":"string","description":"Ad-hoc proctor address line 2"},"place":{"type":"string","description":"Ad-hoc proctor place"},"region":{"type":"string","description":"Ad-hoc proctor region"},"country":{"type":"string","description":"Ad-hoc proctor country"},"locationLatitude":{"type":"string","description":"Ad-hoc proctor location latitude"},"locationLongitude":{"type":"string","description":"Ad-hoc proctor location longitude"},"postalCode":{"type":"string","description":"Ad-hoc proctor postal code"}}},"Model64":{"type":"string","description":"Type C","enum":["Online","Written"]},"Model65":{"type":"object","description":"Exam Configuration Instructor Proctor payload","properties":{"sid":{"type":"string","description":"instructorAsProctor sid","pattern":"^CP[a-f0-9]{32}$"},"location":{"type":"string","description":"Location"},"timeType":{"$ref":"#/components/schemas/timeType"},"startTime":{"type":"string","description":"Start Time","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"End Time"},"capacity":{"type":"number","description":"Capacity","nullable":true}},"required":["location","timeType","startTime","endTime"]},"Model66":{"type":"array","description":"List of Instructor as Proctor","items":{"$ref":"#/components/schemas/Model65"}},"Model67":{"type":"array","description":"Types of proctor for exam","minItems":1,"items":{"type":"string","pattern":"^TS[a-f0-9]{32}$"}},"Model68":{"type":"string","description":"Calculator for student to use","enum":["scientific-calc","graphing-calc","matrix-calc","four-function-calc"],"nullable":true},"Model69":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an existing rule, generated when it is left out","maxLength":64},"label":{"type":"string","description":"A human readable name for the site","example":"Cengage SALT","nullable":true,"maxLength":120},"url":{"type":"string","description":"The URL to allow, or the pattern when the match type is regex","example":"https://www.webassign.net/csalt/","maxLength":2048},"match":{"$ref":"#/components/schemas/match"},"includeSubdomains":{"type":"boolean","description":"Whether subdomains of the host are allowed as well","default":false},"enabled":{"type":"boolean","description":"Whether the rule is currently in effect","default":true}},"required":["url"]},"ExamAllowedSitesUpdate":{"type":"array","description":"Sites students may open in a new tab while new tabs are disabled","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/Model69"}},"Model70":{"type":"object","properties":{"examOpenDate":{"type":"string","description":"Exam Open Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"examCloseDate":{"type":"string","description":"Exam Close Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"scheduleOpenDate":{"type":"string","description":"Schedule Open Date","example":"1970-01-01T00:00:00.000Z","default":"2000-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"scheduleCloseDate":{"type":"string","description":"Schedule Close Date","example":"1970-01-01T00:00:00.000Z","default":"2070-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"password":{"type":"string","description":"Password"},"duration":{"type":"integer","description":"Duration Minutes","x-constraint":{"sign":"positive"}},"attempts":{"type":"integer","description":"Attempts Allowed","x-constraint":{"sign":"positive"}},"requiredSoftware":{"type":"string","description":"Required Software","nullable":true},"studentNotes":{"type":"string","description":"Student Notes","nullable":true},"permittedBathroomBreak":{"type":"boolean","description":"Is Bathroom Break permitted"},"permittedBathroomBreakInformation":{"type":"string","description":"Additional Information about bathroom break","nullable":true},"permittedBlankPaper":{"type":"boolean","description":"Is blank paper permitted"},"permittedBlankPaperInformation":{"type":"string","description":"Additional Information about blank paper","nullable":true},"permittedCalculator":{"type":"boolean","description":"Is calculator permitted"},"permittedCalculatorInformation":{"type":"string","description":"Additional Information about calculator","nullable":true},"permittedDictionary":{"type":"boolean","description":"Is Dictionary permitted"},"permittedDictionaryInformation":{"type":"string","description":"Additional Information about Dictionary","nullable":true},"permittedEarplugs":{"type":"boolean","description":"Is Earplugs permitted"},"permittedEarplugsInformation":{"type":"string","description":"Additional Information about Earplugs","nullable":true},"permittedFormulaSheet":{"type":"boolean","description":"Is FormulaSheet permitted"},"permittedFormulaSheetInformation":{"type":"string","description":"Additional Information about FormulaSheet","nullable":true},"permittedNotes":{"type":"boolean","description":"Is Notes permitted"},"permittedNotesInformation":{"type":"string","description":"Additional Information about Notes","nullable":true},"permittedOtherItems":{"type":"string","description":"Other permitted Items","nullable":true},"permittedTextbook":{"type":"boolean","description":"Is Textbook permitted"},"permittedTextbookInformation":{"type":"string","description":"Additional Information about Textbook","nullable":true},"permittedWebsites":{"type":"boolean","description":"Is Websites permitted"},"permittedWebsitesInformation":{"type":"string","description":"Additional Information about Websites","nullable":true},"proctorNotes":{"type":"string","description":"Proctor Notes","nullable":true},"instructorAsProctor":{"$ref":"#/components/schemas/Model66"},"proctorTypes":{"$ref":"#/components/schemas/Model67"},"virtualCalculatorType":{"$ref":"#/components/schemas/Model68"},"modalityOptions":{"$ref":"#/components/schemas/modalityOptions"},"allowedSites":{"$ref":"#/components/schemas/ExamAllowedSitesUpdate"},"allowedSitesInheritance":{"$ref":"#/components/schemas/allowedSitesInheritance"}},"required":["examOpenDate","examCloseDate","duration","attempts","requiredSoftware","studentNotes","permittedBathroomBreak","permittedBathroomBreakInformation","permittedBlankPaper","permittedBlankPaperInformation","permittedCalculator","permittedCalculatorInformation","permittedDictionary","permittedDictionaryInformation","permittedEarplugs","permittedEarplugsInformation","permittedFormulaSheet","permittedFormulaSheetInformation","permittedNotes","permittedNotesInformation","permittedOtherItems","permittedTextbook","permittedTextbookInformation","permittedWebsites","permittedWebsitesInformation","proctorNotes","instructorAsProctor","proctorTypes"]},"Model71":{"type":"string","description":"Status of the exam. `active` exams are visible, `draft` are in preparation, `deleted` are soft-deleted.","example":"active","enum":["active","draft","deleted"]},"ExamUpdate":{"type":"object","description":"Payload for updating an exam with full configuration.","properties":{"title":{"type":"string","description":"Title C"},"type":{"$ref":"#/components/schemas/Model64"},"description":{"type":"string","description":"Description C","nullable":true},"useProctorManager":{"type":"boolean","description":"Use Proctor Manager C"},"requireApproval":{"type":"boolean","description":"Require Approval C"},"examDeliverySystemModule":{"type":"string","description":"Exam Delivery System Module. Optional field controlled by feature flag.","nullable":true},"contactUserSid":{"type":"string","description":"Contact User Sid","nullable":true,"pattern":"^US[a-f0-9]{32}$"},"isLimitedScope":{"type":"boolean","description":"Boolean to assign exam to all or a few students","default":false},"url":{"type":"string","description":"Exam URL"},"enableAppointmentSuggestions":{"type":"boolean","description":"Enable Appointment Suggestions C"},"configuration":{"$ref":"#/components/schemas/Model70"},"status":{"$ref":"#/components/schemas/Model71"}},"required":["title","type","useProctorManager","requireApproval","url","enableAppointmentSuggestions","configuration"]},"Model72":{"type":"string","description":"Status","enum":["Open","Closed"]},"ExamSessionEventReportUpdate":{"type":"object","description":"Exam Session Event Report payload","properties":{"subject":{"type":"string","description":"Subject"},"details":{"type":"string","description":"Details","nullable":true},"status":{"$ref":"#/components/schemas/Model72"},"eventTime":{"type":"string","description":"Event Time","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"potentialDamage":{"type":"string","description":"Potential Damage","nullable":true},"correctiveActionDetails":{"type":"string","description":"Corrective Action Details","nullable":true},"directWitness":{"type":"string","description":"Direct Witness"},"contactPerson":{"type":"string","description":"Contact Person"},"contactPhone":{"type":"string","description":"Contact Phone"},"contactEmail":{"type":"string","description":"Contact Email","x-format":{"email":true}},"eventTypeSid":{"type":"string","description":"Event Type","pattern":"^ET[a-f0-9]{32}$"},"draft":{"type":"boolean","description":"Draft"}},"required":["subject","status","eventTime","directWitness","contactPerson","contactPhone","contactEmail","draft"]},"Model73":{"type":"object","description":"Exam Configuration Instructor Proctor payload","properties":{"sid":{"type":"string","description":"instructorAsProctor sid","pattern":"^CP[a-f0-9]{32}$"},"location":{"type":"string","description":"Location"},"timeType":{"$ref":"#/components/schemas/timeType"},"startTime":{"type":"string","description":"Start Time","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"End Time"},"capacity":{"type":"number","description":"Capacity","nullable":true}},"required":["location","timeType","startTime","endTime"]},"Model74":{"type":"array","description":"List of Instructor as Proctor","items":{"$ref":"#/components/schemas/Model73"}},"Model75":{"type":"array","description":"Types of proctor for exam","items":{"type":"string","pattern":"^TS[a-f0-9]{32}$"}},"Model76":{"type":"object","properties":{"attachmentUrl":{"type":"string","description":"Attachment AWS URL"},"attachmentAwsTitle":{"type":"string","description":"Attachment AWS Title"}}},"attachments":{"type":"array","description":"Exam attachments","minItems":1,"maxItems":5,"items":{"$ref":"#/components/schemas/Model76"}},"Model77":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an existing rule, generated when it is left out","maxLength":64},"label":{"type":"string","description":"A human readable name for the site","example":"Cengage SALT","nullable":true,"maxLength":120},"url":{"type":"string","description":"The URL to allow, or the pattern when the match type is regex","example":"https://www.webassign.net/csalt/","maxLength":2048},"match":{"$ref":"#/components/schemas/match"},"includeSubdomains":{"type":"boolean","description":"Whether subdomains of the host are allowed as well","default":false},"enabled":{"type":"boolean","description":"Whether the rule is currently in effect","default":true}},"required":["url"]},"ExamConfigurationAllowedSitesUpdate":{"type":"array","description":"Sites students may open in a new tab while new tabs are disabled","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/Model77"}},"ExamConfigurationUpdate":{"type":"object","description":"Exam configuration update payload","properties":{"instructorAsProctor":{"$ref":"#/components/schemas/Model74"},"examOpenDate":{"type":"string","description":"Exam Open Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"examCloseDate":{"type":"string","description":"Exam Close Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"scheduleOpenDate":{"type":"string","description":"Schedule Open Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"scheduleCloseDate":{"type":"string","description":"Schedule Close Date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"enrollmentSid":{"type":"string","description":"Enrollment sid","pattern":"^EN[a-f0-9]{32}$"},"url":{"type":"string","nullable":true},"password":{"type":"string","description":"Password"},"duration":{"type":"integer","description":"Duration Minutes","x-constraint":{"sign":"positive"}},"attempts":{"type":"integer","description":"Attempts Allowed","x-constraint":{"sign":"positive"}},"requiredSoftware":{"type":"string","description":"Required Software","nullable":true},"studentNotes":{"type":"string","description":"Student Notes","nullable":true},"permittedBathroomBreak":{"type":"boolean","description":"Is Bathroom Break permitted"},"permittedBathroomBreakInformation":{"type":"string","description":"Additional Information about bathroom break","nullable":true},"permittedBlankPaper":{"type":"boolean","description":"Is blank paper permitted"},"permittedBlankPaperInformation":{"type":"string","description":"Additional Information about blank paper","nullable":true},"permittedCalculator":{"type":"boolean","description":"Is calculator permitted"},"permittedCalculatorInformation":{"type":"string","description":"Additional Information about calculator","nullable":true},"permittedDictionary":{"type":"boolean","description":"Is Dictionary permitted"},"permittedDictionaryInformation":{"type":"string","description":"Additional Information about Dictionary","nullable":true},"permittedEarplugs":{"type":"boolean","description":"Is Earplugs permitted"},"permittedEarplugsInformation":{"type":"string","description":"Additional Information about Earplugs","nullable":true},"permittedFormulaSheet":{"type":"boolean","description":"Is FormulaSheet permitted"},"permittedFormulaSheetInformation":{"type":"string","description":"Additional Information about FormulaSheet","nullable":true},"permittedNotes":{"type":"boolean","description":"Is Notes permitted"},"permittedNotesInformation":{"type":"string","description":"Additional Information about Notes","nullable":true},"permittedOtherItems":{"type":"string","description":"Other permitted Items","nullable":true},"permittedTextbook":{"type":"boolean","description":"Is Textbook permitted"},"permittedTextbookInformation":{"type":"string","description":"Additional Information about Textbook","nullable":true},"permittedWebsites":{"type":"boolean","description":"Is Websites permitted"},"permittedWebsitesInformation":{"type":"string","description":"Additional Information about Websites","nullable":true},"proctorNotes":{"type":"string","description":"Proctor Notes","nullable":true},"proctorTypes":{"$ref":"#/components/schemas/Model75"},"refConfigSid":{"type":"string","description":"reference configuration sid","pattern":"^EC[a-f0-9]{32}$"},"attachments":{"$ref":"#/components/schemas/attachments"},"modalityOptions":{"$ref":"#/components/schemas/modalityOptions"},"allowedSites":{"$ref":"#/components/schemas/ExamConfigurationAllowedSitesUpdate"},"allowedSitesInheritance":{"$ref":"#/components/schemas/allowedSitesInheritance"}},"required":["instructorAsProctor","permittedBathroomBreak","permittedBathroomBreakInformation","permittedBlankPaper","permittedBlankPaperInformation","permittedCalculator","permittedCalculatorInformation","permittedDictionary","permittedDictionaryInformation","permittedEarplugs","permittedEarplugsInformation","permittedFormulaSheet","permittedFormulaSheetInformation","permittedNotes","permittedNotesInformation","permittedOtherItems","permittedTextbook","permittedTextbookInformation","permittedWebsites","permittedWebsitesInformation"]},"Model78":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an existing rule, generated when it is left out","maxLength":64},"label":{"type":"string","description":"A human readable name for the site","example":"Cengage SALT","nullable":true,"maxLength":120},"url":{"type":"string","description":"The URL to allow, or the pattern when the match type is regex","example":"https://www.webassign.net/csalt/","maxLength":2048},"match":{"$ref":"#/components/schemas/match"},"includeSubdomains":{"type":"boolean","description":"Whether subdomains of the host are allowed as well","default":false},"enabled":{"type":"boolean","description":"Whether the rule is currently in effect","default":true}},"required":["url"]},"ExamConfigurationAllowedSitesUpdateOnly":{"type":"array","description":"Sites students may open in a new tab while new tabs are disabled","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/Model78"}},"ExamConfigurationAllowedSitesPayload":{"type":"object","description":"Sites students may open in a new tab during this exam","properties":{"allowedSites":{"$ref":"#/components/schemas/ExamConfigurationAllowedSitesUpdateOnly"},"allowedSitesInheritance":{"$ref":"#/components/schemas/allowedSitesInheritance"}},"required":["allowedSites"]},"Model79":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","description":"file"}},"examFiles":{"type":"array","x-constraint":{"length":1,"single":true},"items":{"type":"string","description":"exam files"}},"ExamAttachments":{"type":"object","description":"Exam attachments","properties":{"attachments":{"$ref":"#/components/schemas/Model79"},"examFiles":{"$ref":"#/components/schemas/examFiles"}}},"Model80":{"type":"string","enum":["b-virtual","ad-hoc","instructor-as-proctor","messaging","proctoru","register-blast","vtc","examity","smarter-scheduling","automated"]},"Model81":{"type":"string","description":"Reason for session cancellation","enum":["no-show","changed-time","technical-issue","other-reason","removed-by-limited-scope"]},"CancelExamSession":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model80"},"cancellationMemo":{"type":"string","description":"Memo for cancelling the exam session"},"reason":{"$ref":"#/components/schemas/Model81"},"bypassNonRefundable":{"type":"boolean","description":"Whether to bypass non-refundable scheduling fees. If true, all non-refundable fees will be refunded","default":false}},"required":["cancellationMemo"]},"Model82":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","description":"file name"}},"DeleteExamAttachments":{"type":"object","description":"Payload to delete attachments","properties":{"attachments":{"$ref":"#/components/schemas/Model82"},"examFiles":{"$ref":"#/components/schemas/examFiles"}}}}},"paths":{"/v1/installs/{installSid}/settings":{"get":{"summary":"Get Settings","operationId":"getV1InstallsInstallsidSettings","description":"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.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Must match the pattern `AI` followed by 32 hex characters.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Must match the pattern `AI` followed by 32 hex characters.","required":true}],"tags":["App Install"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppInstallSettingsResponse"}}}}}}},"/v1/installs/{installSid}/courses/{courseSid}/users":{"get":{"summary":"Search for users enrolled in a course by name","operationId":"getV1InstallsInstallsidCoursesCoursesidUsers","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","example":"CU1234567890abcdef1234567890abcdef","pattern":"^CU[a-f0-9]{32}$"},"description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","required":true},{"name":"search","in":"query","schema":{"type":"string","description":"Search term to match against first name or last name (case-insensitive, partial match). Use empty string to return all users.","maxLength":255},"description":"Search term to match against first name or last name (case-insensitive, partial match). Use empty string to return all users.","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Zero-based offset for pagination.","default":0,"minimum":0},"description":"Zero-based offset for pagination."},{"name":"role","in":"query","schema":{"type":"string","description":"Filter results to a specific enrollment role. If omitted, all roles are returned.","enum":["learner","instructor"]},"description":"Filter results to a specific enrollment role. If omitted, all roles are returned."},{"name":"limit","in":"query","schema":{"type":"integer","description":"Maximum number of results to return. Default 25, max 100.","default":25,"minimum":1,"maximum":100},"description":"Maximum number of results to return. Default 25, max 100."}],"tags":["Course"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/courseOfferings":{"get":{"summary":"List Course Offerings","operationId":"getV1InstallsInstallsidCourseofferings","description":"Returns a paginated list of course offerings (terms/semesters) for the specified application install.<br/><br/>Supports standard pagination via `offset` and `limit`.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Zero-based offset for pagination. Indicates how many records to skip.","example":0,"minimum":0},"description":"Zero-based offset for pagination. Indicates how many records to skip."},{"name":"limit","in":"query","schema":{"type":"integer","description":"Maximum number of course offering records to return.","example":25,"minimum":0},"description":"Maximum number of course offering records to return."}],"tags":["Course Offering"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseOfferingListResponse"}}}}}},"post":{"summary":"Create Course Offering","operationId":"postV1InstallsInstallsidCourseofferings","description":"Creates a new course offering (e.g., semester, term, or academic period) under the specified application install.<br/><br/>The `matchStrings` field is used to automatically match incoming courses from the LMS to this offering based on text patterns.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true}],"tags":["Course Offering"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseOffering"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseOfferingResponse"}}}}}}},"/v1/installs/{installSid}/courseOfferings/{offeringSid}":{"get":{"summary":"Course Offering Details","operationId":"getV1InstallsInstallsidCourseofferingsOfferingsid","description":"Returns the full course offering object for the specified offering SID.<br/><br/>Includes title, match strings, start/end dates, and associated metadata.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"offeringSid","in":"path","schema":{"type":"string","description":"Unique SID of the course offering to retrieve. Pattern: `CO` + 32 hex chars.","example":"CO1234567890abcdef1234567890abcdef","pattern":"^CO[a-f0-9]{32}$"},"description":"Unique SID of the course offering to retrieve. Pattern: `CO` + 32 hex chars.","required":true}],"tags":["Course Offering"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseOfferingResponse"}}}}}},"put":{"summary":"Update Course Offering","operationId":"putV1InstallsInstallsidCourseofferingsOfferingsid","description":"Replaces the full course offering configuration with the provided payload.<br/><br/>All required fields (`title`, `matchStrings`) must be provided.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"offeringSid","in":"path","schema":{"type":"string","description":"Unique SID of the course offering to update. Pattern: `CO` + 32 hex chars.","example":"CO1234567890abcdef1234567890abcdef","pattern":"^CO[a-f0-9]{32}$"},"description":"Unique SID of the course offering to update. Pattern: `CO` + 32 hex chars.","required":true}],"tags":["Course Offering"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseOfferingUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseOfferingResponse"}}}}}},"delete":{"summary":"Delete Course Offering","operationId":"deleteV1InstallsInstallsidCourseofferingsOfferingsid","description":"Permanently deletes the specified course offering.<br/><br/>Courses currently assigned to this offering may need to be reassigned.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"offeringSid","in":"path","schema":{"type":"string","description":"Unique SID of the course offering to delete. Pattern: `CO` + 32 hex chars.","example":"CO1234567890abcdef1234567890abcdef","pattern":"^CO[a-f0-9]{32}$"},"description":"Unique SID of the course offering to delete. Pattern: `CO` + 32 hex chars.","required":true}],"tags":["Course Offering"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/courses/{courseSid}/exams":{"get":{"summary":"List Exams","operationId":"getV1InstallsInstallsidCoursesCoursesidExams","description":"Returns a paginated list of exams belonging to the specified course.<br/><br/>Supports filtering with `includeStatusSummary` to include enrollment status counts per exam.<br/><br/>Supports sorting by `title`, `examOpenDate`, or `scheduleOpenDate`.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","example":"CU1234567890abcdef1234567890abcdef","pattern":"^CU[a-f0-9]{32}$"},"description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Zero-based offset for pagination.","example":0,"minimum":0},"description":"Zero-based offset for pagination."},{"name":"limit","in":"query","schema":{"type":"integer","description":"Maximum number of exam records to return.","example":50,"minimum":0},"description":"Maximum number of exam records to return."},{"name":"includeStatusSummary","in":"query","schema":{"type":"boolean","description":"When true, includes a summary of enrollment statuses (e.g., scheduled, completed, not started) for each exam.","example":true,"default":false},"description":"When true, includes a summary of enrollment statuses (e.g., scheduled, completed, not started) for each exam."},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Array of field names to sort by. Valid values: `title`, `examOpenDate`, `scheduleOpenDate`.","x-constraint":{"single":true},"items":{"type":"string","enum":["title","examOpenDate","scheduleOpenDate"]}},"description":"Array of field names to sort by. Valid values: `title`, `examOpenDate`, `scheduleOpenDate`.","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort direction. `ASC` for ascending or `DESC` for descending.","enum":["ASC","DESC"]},"description":"Sort direction. `ASC` for ascending or `DESC` for descending."},{"name":"dob","in":"query","schema":{"type":"string","format":"date","description":"Date of birth filter (internal use)."},"description":"Date of birth filter (internal use)."}],"tags":["Exam"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Create Exam","operationId":"postV1InstallsInstallsidCoursesCoursesidExams","description":"Creates a new exam configuration under the specified course.<br/><br/>The payload includes exam metadata (title, type, URL), proctoring configuration, permitted items, scheduling windows, and instructor-as-proctor settings.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","example":"CU1234567890abcdef1234567890abcdef","pattern":"^CU[a-f0-9]{32}$"},"description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","required":true}],"tags":["Exam"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exam"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamResponse"}}}}}}},"/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}":{"get":{"summary":"Exam Details","operationId":"getV1InstallsInstallsidCoursesCoursesidExamsExamsid","description":"Returns the full exam object including configuration, permitted items, proctoring settings, and scheduling windows.<br/><br/>Also evaluates the LaunchDarkly virtual test center version feature flag for the requesting user.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","example":"CU1234567890abcdef1234567890abcdef","pattern":"^CU[a-f0-9]{32}$"},"description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Unique SID of the exam to retrieve. Pattern: `EX` + 32 hex chars.","example":"EX1234567890abcdef1234567890abcdef","pattern":"^EX[a-f0-9]{32}$"},"description":"Unique SID of the exam to retrieve. Pattern: `EX` + 32 hex chars.","required":true}],"tags":["Exam"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamResponse"}}}}}},"put":{"summary":"Update Exam","operationId":"putV1InstallsInstallsidCoursesCoursesidExamsExamsid","description":"Replaces the full exam configuration with the provided payload.<br/><br/>Includes exam metadata, scheduling windows, permitted items, proctoring settings, and instructor-as-proctor configurations.<br/><br/>The user role from the auth token is passed to the handler for role-based logic.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","example":"CU1234567890abcdef1234567890abcdef","pattern":"^CU[a-f0-9]{32}$"},"description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Unique SID of the exam to update. Pattern: `EX` + 32 hex chars.","example":"EX1234567890abcdef1234567890abcdef","pattern":"^EX[a-f0-9]{32}$"},"description":"Unique SID of the exam to update. Pattern: `EX` + 32 hex chars.","required":true}],"tags":["Exam"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamResponse"}}}}}},"delete":{"summary":"Delete Exam","operationId":"deleteV1InstallsInstallsidCoursesCoursesidExamsExamsid","description":"Performs a soft delete on the specified exam, marking it as deleted without permanently removing data.<br/><br/>The exam will no longer appear in active listings but its data is retained.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","example":"CU1234567890abcdef1234567890abcdef","pattern":"^CU[a-f0-9]{32}$"},"description":"Unique SID of the course. Pattern: `CU` + 32 hex chars.","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Unique SID of the exam to delete. Pattern: `EX` + 32 hex chars.","example":"EX1234567890abcdef1234567890abcdef","pattern":"^EX[a-f0-9]{32}$"},"description":"Unique SID of the exam to delete. Pattern: `EX` + 32 hex chars.","required":true}],"tags":["Exam"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/assignments":{"get":{"summary":"Get exam assignments","operationId":"getV1InstallsInstallsidExamsExamsidAssignments","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Unique SID of the exam whose assignments are being retrieved. Pattern: `EX` + 32 hex chars.","example":"EX1234567890abcdef1234567890abcdef","pattern":"^EX[a-f0-9]{32}$"},"description":"Unique SID of the exam whose assignments are being retrieved. Pattern: `EX` + 32 hex chars.","required":true}],"tags":["Exam"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Update exam assignments","operationId":"putV1InstallsInstallsidExamsExamsidAssignments","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","example":"AI1234567890abcdef1234567890abcdef","pattern":"^AI[a-f0-9]{32}$"},"description":"Unique SID of the application install. Pattern: `AI` + 32 hex chars.","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Unique SID of the exam whose assignments are being modified. Pattern: `EX` + 32 hex chars.","example":"EX1234567890abcdef1234567890abcdef","pattern":"^EX[a-f0-9]{32}$"},"description":"Unique SID of the exam whose assignments are being modified. Pattern: `EX` + 32 hex chars.","required":true}],"tags":["Exam"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExamAssignment"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations":{"get":{"summary":"List Configurations","operationId":"getV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurations","description":"Returns a paginated list of exam configurations for the specified exam.<br/><br/>Can be filtered by `enrollmentSid` to find configurations for a specific student.<br/><br/>Supports sorting and pagination via query parameters.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Offset for pagination","default":0,"minimum":0},"description":"Offset for pagination"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Keys to sort the data","x-constraint":{"single":true},"items":{"type":"string","pattern":"^[a-z]+\\w*$"}},"description":"Keys to sort the data","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Order of sorting","default":"ASC","enum":["ASC","DESC"]},"description":"Order of sorting"},{"name":"enrollmentSid","in":"query","schema":{"type":"string","description":"Enrollment Sid","pattern":"^EN[a-f0-9]{32}$"},"description":"Enrollment Sid"}],"tags":["Exam Configuration"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfigurationListResponse"}}}}}},"post":{"summary":"Create Configuration","operationId":"postV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurations","description":"Creates a new exam configuration (e.g., student-specific overrides for scheduling windows, permitted items, and proctoring settings).<br/><br/>The payload must include either `enrollmentSid` or `referenceExamConfigurationSid` (XOR constraint).","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true}],"tags":["Exam Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfiguration"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfigurationResponse"}}}}}}},"/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}":{"get":{"summary":"Get Configuration Details","operationId":"getV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurationsExamconfigurationsid","description":"Returns the full exam configuration including scheduling windows, permitted items, proctoring settings, and instructor-as-proctor entries.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"examConfigurationSid","in":"path","schema":{"type":"string","description":"ExamConfiguration Sid","pattern":"^EC[a-f0-9]{32}$"},"description":"ExamConfiguration Sid","required":true}],"tags":["Exam Configuration"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfigurationResponse"}}}}}},"put":{"summary":"Update Configuration","operationId":"putV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurationsExamconfigurationsid","description":"Replaces the full exam configuration with the provided payload including scheduling, permitted items, proctoring settings, and instructor-as-proctor entries.<br/><br/>The user role from the auth token is passed to the handler for role-based logic.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"examConfigurationSid","in":"path","schema":{"type":"string","description":"Exam Configuration sid","pattern":"^EC[a-f0-9]{32}$"},"description":"Exam Configuration sid","required":true}],"tags":["Exam Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfigurationUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfigurationResponse"}}}}}},"delete":{"summary":"Delete Configuration","operationId":"deleteV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurationsExamconfigurationsid","description":"Permanently deletes the specified exam configuration.<br/><br/>Returns a success message upon successful deletion.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"examConfigurationSid","in":"path","schema":{"type":"string","description":"Exam Configuration Sid","pattern":"^EC[a-f0-9]{32}$"},"description":"Exam Configuration Sid","required":true}],"tags":["Exam Configuration"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}/allowedSites":{"put":{"summary":"Replace the sites allowed during an exam","operationId":"putV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurationsExamconfigurationsidAllowedsites","description":"Sets the sites students may open in a new tab while taking this exam, and whether those add to the sites allowed by the app install and the exam delivery system or replace them.<br/><br/>Rules are normalized before they are stored, so the URL that comes back may differ from the one that was sent. Patterns are not accepted here.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"examConfigurationSid","in":"path","schema":{"type":"string","description":"Exam Configuration sid","pattern":"^EC[a-f0-9]{32}$"},"description":"Exam Configuration sid","required":true}],"tags":["Exam Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfigurationAllowedSitesPayload"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamConfigurationResponse"}}}}}}},"/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations/{examConfigurationSid}/attachments":{"put":{"summary":"Upload Attachments","operationId":"putV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurationsExamconfigurationsidAttachments","description":"Uploads exam file attachments (e.g., exam papers, instruction sheets) via multipart/form-data.<br/><br/>Accepts up to 5 attachment files or 1 exam file per request.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"examConfigurationSid","in":"path","schema":{"type":"string","description":"Exam Configuration sid","pattern":"^EC[a-f0-9]{32}$"},"description":"Exam Configuration sid","required":true}],"tags":["Exam Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamAttachments"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete Attachments","operationId":"deleteV1InstallsInstallsidCoursesCoursesidExamsExamsidConfigurationsExamconfigurationsidAttachments","description":"Removes specified attachment files or exam files from the exam configuration.<br/><br/>The payload specifies file names to delete from attachments or examFiles arrays.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"courseSid","in":"path","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"examConfigurationSid","in":"path","schema":{"type":"string","description":"Exam Configuration sid","pattern":"^EC[a-f0-9]{32}$"},"description":"Exam Configuration sid","required":true}],"tags":["Exam Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExamAttachments"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/events":{"get":{"summary":"List Exam Events","operationId":"getV1InstallsInstallsidExamsExamsidEvents","description":"Returns a paginated list of event reports across all sessions for the specified exam.<br/><br/>Supports filtering and sorting via query parameters.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Offset for pagination","minimum":0},"description":"Offset for pagination"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","default":50,"minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Sort keys","x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate"]}},"description":"Sort keys","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"},{"name":"status","in":"query","schema":{"type":"string","description":"Event status","enum":["Open","Closed"]},"description":"Event status"}],"tags":["Exam Events"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/eventsByStudent":{"get":{"summary":"Events By Student","operationId":"getV1InstallsInstallsidExamsExamsidEventsbystudent","description":"Returns event reports for the specified exam, grouped by student/enrollment.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true}],"tags":["Exam Events"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions":{"get":{"summary":"List enrollment exam sessions","operationId":"getV1InstallsInstallsidEnrollmentsEnrollmentsidExamsExamsidSessions","description":"Returns a paginated list of exam sessions for the given enrollment and exam combination.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"enrollmentSid","in":"path","schema":{"type":"string","description":"Enrollment Sid","pattern":"^EN[a-f0-9]{32}$"},"description":"Enrollment Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Id to get next portion of query data. For 1st query should pass as empty","minimum":0},"description":"Id to get next portion of query data. For 1st query should pass as empty"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Sort keys","x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate"]}},"description":"Sort keys","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"},{"name":"status","in":"query","schema":{"type":"array","description":"Status List","x-constraint":{"single":true},"items":{"type":"string","enum":["Needs Proctor","Pending Approval","Approval Denied","Scheduled","Incident","Closed","Processing"]}},"description":"Status List","style":"form","explode":true},{"name":"includeActive","in":"query","schema":{"type":"boolean","description":"Include Active Session","default":false},"description":"Include Active Session"}],"tags":["Exam Session"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionListResponse"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}":{"get":{"summary":"Exam Session Details","operationId":"getV1InstallsInstallsidExamsExamsidSessionsSessionsid","description":"Returns the full exam session object including scheduling, proctoring, and status details.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true}],"tags":["Exam Session"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionResponse"}}}}}},"post":{"summary":"Schedule Exam Session","operationId":"postV1InstallsInstallsidExamsExamsidSessionsSessionsid","description":"Creates a scheduled exam session under the specified exam.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true}],"tags":["Exam Session"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSession"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionResponse"}}}}}},"put":{"summary":"Reschedule Exam Session","operationId":"putV1InstallsInstallsidExamsExamsidSessionsSessionsid","description":"Changes the scheduled date/time for an existing exam session.<br/><br/>The auth token is passed for proctor reassignment and auditing.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true}],"tags":["Exam Session"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescheduleSession"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Cancel Exam Session","operationId":"deleteV1InstallsInstallsidExamsExamsidSessionsSessionsid","description":"Cancels the specified exam session. The auth token is passed for auditing.<br/><br/>An optional payload may include cancellation reason details.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true}],"tags":["Exam Session"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelExamSession"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/close":{"post":{"summary":"Close Exam Session","operationId":"postV1InstallsInstallsidExamsExamsidSessionsSessionsidClose","description":"Closes the exam session, finalizing the session state and triggering post-session workflows.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true}],"tags":["Exam Session"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseSession"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/annotations":{"get":{"summary":"List Annotations","operationId":"getV2InstallsInstallsidExamsExamsidSessionsSessionsidAnnotations","description":"Returns a paginated list of annotations for the specified exam session.<br/><br/>Supports filtering and sorting via query parameters.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true},{"name":"typeId","in":"query","schema":{"type":"string","description":"Type identifier for the annotation","maxLength":50},"description":"Type identifier for the annotation"},{"name":"categoryId","in":"query","schema":{"type":"string","description":"Category for the annotation type","maxLength":30},"description":"Category for the annotation type"},{"name":"reviewed","in":"query","schema":{"type":"boolean","description":"Filter annotations by reviewed status"},"description":"Filter annotations by reviewed status"},{"name":"after","in":"query","schema":{"type":"string","description":"Filter annotations created after this date","x-format":{"isoDate":true}},"description":"Filter annotations created after this date"},{"name":"before","in":"query","schema":{"type":"string","description":"Filter annotations created before this date","x-format":{"isoDate":true}},"description":"Filter annotations created before this date"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Sorting keys","default":["createdDate"],"x-constraint":{"single":true},"items":{"type":"string","enum":["sessionSid","typeId","details","score","duration","reviewedDate","reviewerComment","reviewedBy","createdDate","createdById","updatedDate","updatedBy"]}},"description":"Sorting keys","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sorting order","enum":["ASC","DESC"]},"description":"Sorting order"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Pagination offset","minimum":0},"description":"Pagination offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Pagination limit","minimum":1},"description":"Pagination limit"}],"tags":["Exam Session Annotation"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/annotations/{annotationSid}":{"get":{"summary":"Get Annotation Details","operationId":"getV2InstallsInstallsidExamsExamsidSessionsSessionsidAnnotationsAnnotationsid","description":"Returns the full annotation object for the specified annotation SID.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true},{"name":"annotationSid","in":"path","schema":{"type":"string","description":"Identifier of Exam Session Annotation","pattern":"^AN[a-f0-9]{32}$"},"description":"Identifier of Exam Session Annotation","required":true}],"tags":["Exam Session Annotation"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events":{"get":{"summary":"List Event Reports","operationId":"getV1InstallsInstallsidExamsExamsidSessionsSessionsidEvents","description":"Returns a paginated list of session event reports for the specified exam session.<br/><br/>Supports filtering and sorting via query parameters.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Session Sid","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Offset for pagination","minimum":0},"description":"Offset for pagination"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Sort keys","x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate"]}},"description":"Sort keys","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"},{"name":"includeDrafts","in":"query","schema":{"type":"boolean","description":"Include draft event reports","default":false},"description":"Include draft event reports"}],"tags":["Exam Session Event"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionEventReportListResponse"}}}}}},"post":{"summary":"Create Event Report","operationId":"postV1InstallsInstallsidExamsExamsidSessionsSessionsidEvents","description":"Records a session event (e.g., browser focus lost, microphone detected, suspicious activity) on the specified exam session.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Session Sid","required":true}],"tags":["Exam Session Event"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionEventReport"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionEventReportResponse"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events/{eventReportSid}":{"get":{"summary":"Get Event Report","operationId":"getV1InstallsInstallsidExamsExamsidSessionsSessionsidEventsEventreportsid","description":"Returns the full event report object for the specified event report SID.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Session Sid","required":true},{"name":"eventReportSid","in":"path","schema":{"type":"string","description":"Report Sid","pattern":"^ER[a-f0-9]{32}$"},"description":"Report Sid","required":true}],"tags":["Exam Session Event"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionEventReportResponse"}}}}}},"put":{"summary":"Update Event Report","operationId":"putV1InstallsInstallsidExamsExamsidSessionsSessionsidEventsEventreportsid","description":"Updates the specified event report with the provided payload fields.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Session Sid","required":true},{"name":"eventReportSid","in":"path","schema":{"type":"string","description":"Report Sid","pattern":"^ER[a-f0-9]{32}$"},"description":"Report Sid","required":true}],"tags":["Exam Session Event"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionEventReportUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamSessionEventReportResponse"}}}}}},"delete":{"summary":"Delete Event Report","operationId":"deleteV1InstallsInstallsidExamsExamsidSessionsSessionsidEventsEventreportsid","description":"Deletes the specified event report.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam session sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam session sid","required":true},{"name":"eventReportSid","in":"path","schema":{"type":"string","description":"Exam session event report Sid","pattern":"^ER[a-f0-9]{32}$"},"description":"Exam session event report Sid","required":true}],"tags":["Exam Session Event"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/events/{eventReportSid}/close":{"put":{"summary":"Close Event Report","operationId":"putV1InstallsInstallsidExamsExamsidSessionsSessionsidEventsEventreportsidClose","description":"Marks the specified event report as closed/resolved.<br/><br/>The `eventReportSid` is validated through the hierarchy: eventReport → session → exam → appInstall.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application install sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application install sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Session Sid","required":true},{"name":"eventReportSid","in":"path","schema":{"type":"string","description":"Report Sid","pattern":"^ER[a-f0-9]{32}$"},"description":"Report Sid","required":true}],"tags":["Exam Session Event"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/onboard":{"get":{"summary":"Get the onboarding URL for an exam session","operationId":"getV1InstallsInstallsidExamsExamsidSessionsSessionsidOnboard","description":"Returns the onboarding URL where the student completes pre-exam steps (e.g., system check, ID verification).","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examSid","in":"path","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid","required":true},{"name":"sessionSid","in":"path","schema":{"type":"string","description":"Exam Session Sid","pattern":"^ES[a-f0-9]{32}$"},"description":"Exam Session Sid","required":true}],"tags":["Onboarding"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/installs/{installSid}/provision":{"post":{"summary":"Bulk Provision Data","operationId":"postV2InstallsInstallsidProvision","description":"Provisions multiple types of data (e.g., courses, exams, enrollments) in a single bulk operation for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true}],"tags":["Provision"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model40"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/examsByWeek":{"get":{"summary":"Exams By Week","operationId":"getV1InstallsInstallsidExamsbyweek","description":"Returns exams grouped by week based on the given filter parameters.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course offering sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course offering sid"},{"name":"groupBy","in":"query","schema":{"type":"string","description":"The base for grouping the exams","default":"examOpenDate","enum":["examOpenDate","examCloseDate"]},"description":"The base for grouping the exams"},{"name":"status","in":"query","schema":{"type":"string","description":"Active status of the exams","enum":["past","active","upcoming"]},"description":"Active status of the exams"},{"name":"startDate","in":"query","schema":{"type":"string","description":"earliest date to show exams"},"description":"earliest date to show exams"},{"name":"endDate","in":"query","schema":{"type":"string","description":"Latest date to show exams"},"description":"Latest date to show exams"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamsByWeekReportResponse"}}}}}}},"/v1/installs/{installSid}/examVolume":{"get":{"summary":"Exam Volume","operationId":"getV1InstallsInstallsidExamvolume","description":"Returns an exam volume report for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Application Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Application Install Sid","required":true},{"name":"examOpenDate","in":"query","schema":{"type":"string","description":"Exam Open date, must provide close date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Open date, must provide close date with it"},{"name":"examCloseDate","in":"query","schema":{"type":"string","description":"Exam Close date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Close date, must provide open date with it"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Offset for pagination","minimum":0},"description":"Offset for pagination"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Key to sort by","default":["createdDate"],"x-constraint":{"single":true},"items":{"type":"string","enum":["examOpenDate","createdDate"]}},"description":"Key to sort by","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamVolumeReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/aggregatedStats":{"get":{"summary":"Exam Type Stats","operationId":"getV1InstallsInstallsidReportsAggregatedstats","description":"Returns aggregated statistics for exam types for the next 10 days.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatedStatsReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/appointments":{"get":{"summary":"List Appointments","operationId":"getV1InstallsInstallsidReportsAppointments","description":"Returns all appointments based on the given filter parameters.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"courseSid","in":"query","schema":{"type":"string","description":"Course sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course sid"},{"name":"examSid","in":"query","schema":{"type":"string","description":"Exam sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam sid"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course offering sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course offering sid"},{"name":"type","in":"query","schema":{"type":"string","description":"Type of the appointment","enum":["b-virtual","examity","proctoru","register-blast","instructor-as-proctor","messaging","ad-hoc","vtc","automated"]},"description":"Type of the appointment"},{"name":"status","in":"query","schema":{"type":"string","description":"Status of the appointment","enum":["Needs Proctor","Scheduled","Cancelled","In Progress","Closed"]},"description":"Status of the appointment"},{"name":"reviewStatus","in":"query","schema":{"type":"string","description":"If the session needs to be reviewed and/or if it has been reviewed.","enum":["pending","complete","not-required"]},"description":"If the session needs to be reviewed and/or if it has been reviewed."},{"name":"examStatus","in":"query","schema":{"type":"string","description":"Status of the exam","enum":["active","draft","deleted"]},"description":"Status of the exam"},{"name":"appointmentAfter","in":"query","schema":{"type":"string","description":"Appointments after date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointments after date"},{"name":"appointmentBefore","in":"query","schema":{"type":"string","description":"Appointments before date","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointments before date"},{"name":"learnerFirstName","in":"query","schema":{"type":"string","description":"learner first name","pattern":"^[^%]*$"},"description":"learner first name"},{"name":"learnerLastName","in":"query","schema":{"type":"string","description":"Learners last name","pattern":"^[^%]*$"},"description":"Learners last name"},{"name":"learnerEmail","in":"query","schema":{"type":"string","description":"Learners email","pattern":"^[^%]*$"},"description":"Learners email"},{"name":"learnerSid","in":"query","schema":{"type":"string","description":"Learners sid","pattern":"^[^%]*$"},"description":"Learners sid"},{"name":"courseTitle","in":"query","schema":{"type":"string","description":"Course title","pattern":"^[^%]*$"},"description":"Course title"},{"name":"examTitle","in":"query","schema":{"type":"string","description":"Exam title","pattern":"^[^%]*$"},"description":"Exam title"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/appointmentVolume":{"get":{"summary":"Appointment Volume","operationId":"getV1InstallsInstallsidReportsAppointmentvolume","description":"Returns an appointment volume (peak exam) report for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"},{"name":"courseSid","in":"query","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid"},{"name":"examSid","in":"query","schema":{"type":"string","description":"Exam sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam sid"},{"name":"appointmentDateRangeStart","in":"query","schema":{"type":"string","description":"Appointment Date Range Start","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointment Date Range Start"},{"name":"appointmentDateRangeEnd","in":"query","schema":{"type":"string","description":"Appointment Date Range End","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointment Date Range End"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentVolumeReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/audit":{"get":{"summary":"Written Exam Audit","operationId":"getV1InstallsInstallsidReportsAudit","description":"Returns an audit report for written exams within the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"examOpenDate","in":"query","schema":{"type":"string","description":"Starting of event, must provide end date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Starting of event, must provide end date with it"},{"name":"examCloseDate","in":"query","schema":{"type":"string","description":"Exam Close date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Close date, must provide open date with it"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","default":["createdDate"],"x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate"]}},"style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/churn":{"get":{"summary":"Churn Report","operationId":"getV1InstallsInstallsidReportsChurn","description":"Returns a churn report for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseTitle","in":"query","schema":{"type":"string","description":"Course title"},"description":"Course title"},{"name":"examTitle","in":"query","schema":{"type":"string","description":"Exam title"},"description":"Exam title"},{"name":"email","in":"query","schema":{"type":"string","description":"Student Email"},"description":"Student Email"},{"name":"firstName","in":"query","schema":{"type":"string","description":"First Name of student"},"description":"First Name of student"},{"name":"lastName","in":"query","schema":{"type":"string","description":"Last Name of student"},"description":"Last Name of student"},{"name":"examOpenDate","in":"query","schema":{"type":"string","description":"Starting of event, must provide end date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Starting of event, must provide end date with it"},{"name":"examCloseDate","in":"query","schema":{"type":"string","description":"Exam Close date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Close date, must provide open date with it"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"},{"name":"hasCancelled","in":"query","schema":{"type":"boolean","description":"include if Cancelled session exist"},"description":"include if Cancelled session exist"},{"name":"hasClosed","in":"query","schema":{"type":"boolean","description":"include if closed session exist"},"description":"include if closed session exist"},{"name":"currentStatus","in":"query","schema":{"type":"array","description":"Current status of student","x-constraint":{"single":true},"items":{"type":"string","enum":["Needs Proctor","Closed","Scheduled"]}},"description":"Current status of student","style":"form","explode":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","default":["courseTitle","examTitle"],"x-constraint":{"single":true},"items":{"type":"string","enum":["courseTitle","examTitle","createdDate"]}},"style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChurnReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/examOverview":{"get":{"summary":"Exam Overview","operationId":"getV1InstallsInstallsidReportsExamoverview","description":"Returns an exam overview report for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course offering","pattern":"^CO[a-f0-9]{32}$"},"description":"Course offering"},{"name":"courseTitle","in":"query","schema":{"type":"string","description":"Title of the course"},"description":"Title of the course"},{"name":"courseCode","in":"query","schema":{"type":"string","description":"Course code"},"description":"Course code"},{"name":"examTitle","in":"query","schema":{"type":"string","description":"Title of the exam"},"description":"Title of the exam"},{"name":"instructorFirstName","in":"query","schema":{"type":"string","description":"First name of the instructor"},"description":"First name of the instructor"},{"name":"instructorLastName","in":"query","schema":{"type":"string","description":"Last name of the instructor"},"description":"Last name of the instructor"},{"name":"examOpenDate","in":"query","schema":{"type":"string","description":"Exam Open date, must provide close date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Open date, must provide close date with it"},{"name":"examCloseDate","in":"query","schema":{"type":"string","description":"Exam Close date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Close date, must provide open date with it"},{"name":"examScheduleOpenDate","in":"query","schema":{"type":"string","description":"Exam Session Open date, must provide close date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Session Open date, must provide close date with it"},{"name":"examScheduleCloseDate","in":"query","schema":{"type":"string","description":"Exam Session Close date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Session Close date, must provide open date with it"},{"name":"needsProctor","in":"query","schema":{"type":"boolean","description":"Show only the exam that needs proctor"},"description":"Show only the exam that needs proctor"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Key to sort by","enum":["status needs proctor","status cancelled","status scheduled","status closed","examOpenDate","examCloseDate","examScheduleOpenDate","examScheduleCloseDate","examTitle"]},"description":"Key to sort by","required":true}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamOverviewReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/examSessionEvents":{"get":{"summary":"Session Events","operationId":"getV1InstallsInstallsidReportsExamsessionevents","description":"Returns exam session event reports for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseTitle","in":"query","schema":{"type":"string","description":"Course title"},"description":"Course title"},{"name":"examTitle","in":"query","schema":{"type":"string","description":"Exam title"},"description":"Exam title"},{"name":"studentFirstName","in":"query","schema":{"type":"string","description":"First Name of student"},"description":"First Name of student"},{"name":"studentLastName","in":"query","schema":{"type":"string","description":"Last Name of student"},"description":"Last Name of student"},{"name":"instructorFirstName","in":"query","schema":{"type":"string","description":"First Name of Instructor"},"description":"First Name of Instructor"},{"name":"instructorLastName","in":"query","schema":{"type":"string","description":"Last Name of Instructor"},"description":"Last Name of Instructor"},{"name":"eventTypeSid","in":"query","schema":{"type":"string","description":"Event Type Sid","pattern":"^ET[a-f0-9]{32}$"},"description":"Event Type Sid"},{"name":"sessionEventStatus","in":"query","schema":{"type":"string","description":"Event status"},"description":"Event status"},{"name":"eventTimeRangeStart","in":"query","schema":{"type":"string","description":"Starting of event, must provide end date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Starting of event, must provide end date with it"},{"name":"eventTimeRangeEnd","in":"query","schema":{"type":"string","description":"Exam Close date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Close date, must provide open date with it"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"},{"name":"courseSid","in":"query","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid"},{"name":"examSid","in":"query","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Key to sort by","default":["createdDate"],"x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate"]}},"description":"Key to sort by","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"},{"name":"eventSid","in":"query","schema":{"type":"string","description":"Event SID","pattern":"^ER[a-f0-9]{32}$"},"description":"Event SID"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionEventReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/modalityDistribution":{"get":{"summary":"Modality Distribution","operationId":"getV1InstallsInstallsidReportsModalitydistribution","description":"Returns a report on modality distribution for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseSid","in":"query","schema":{"type":"string","description":"Course sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course sid"},{"name":"examSid","in":"query","schema":{"type":"string","description":"Exam sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam sid"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModalityDistributionReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/proctorAccountVolume":{"get":{"summary":"Proctor Volume","operationId":"getV1InstallsInstallsidReportsProctoraccountvolume","description":"Returns a volume report for proctor accounts associated with the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"},{"name":"examSessionStatus","in":"query","schema":{"type":"string","description":"Exam Session Status","default":"Closed","enum":["Pending Review","Scheduled","Needs Proctor","Closed","in-progress","Checked In","Cancelled"],"nullable":true},"description":"Exam Session Status"},{"name":"appointmentDateRangeStart","in":"query","schema":{"type":"string","description":"Appointment Date Range Start","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointment Date Range Start"},{"name":"appointmentDateRangeEnd","in":"query","schema":{"type":"string","description":"Appointment Date Range End","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointment Date Range End"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProctorAccountVolumeReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/serviceDistribution":{"get":{"summary":"Service Distribution","operationId":"getV1InstallsInstallsidReportsServicedistribution","description":"Returns a service distribution report for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"serviceTypes","in":"query","schema":{"type":"array","description":"Types of services to include in the report","x-constraint":{"single":true},"items":{"type":"string","enum":["automated","automated-with-review","live","virtual-test-center","proctoru","register-blast","ad-hoc","messaging"]}},"description":"Types of services to include in the report","style":"form","explode":true},{"name":"statuses","in":"query","schema":{"type":"array","description":"Statuses to include in the report","x-constraint":{"single":true},"items":{"type":"string","enum":["Scheduled","Closed","Cancelled"]}},"description":"Statuses to include in the report","style":"form","explode":true},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course offering sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course offering sid"},{"name":"courseSid","in":"query","schema":{"type":"string","description":"Course sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course sid"},{"name":"courseTitle","in":"query","schema":{"type":"string","description":"Course title"},"description":"Course title"},{"name":"courseCode","in":"query","schema":{"type":"string","description":"Course code"},"description":"Course code"},{"name":"examTitle","in":"query","schema":{"type":"string","description":"Exam title"},"description":"Exam title"},{"name":"examSid","in":"query","schema":{"type":"string","description":"Exam sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam sid"},{"name":"appointmentDateAfter","in":"query","schema":{"type":"string","description":"Appointments after date (inclusive)","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointments after date (inclusive)"},{"name":"appointmentDateBefore","in":"query","schema":{"type":"string","description":"Appointments before date (exclusive)","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Appointments before date (exclusive)"},{"name":"closeDateAfter","in":"query","schema":{"type":"string","description":"Close date after (inclusive)","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Close date after (inclusive)"},{"name":"closeDateBefore","in":"query","schema":{"type":"string","description":"Close date before (exclusive)","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Close date before (exclusive)"},{"name":"userSid","in":"query","schema":{"type":"string","description":"User sid","pattern":"^US[a-f0-9]{32}$"},"description":"User sid"},{"name":"billable","in":"query","schema":{"type":"boolean","description":"Filter by billable sessions"},"description":"Filter by billable sessions"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","default":50,"minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Key to sort by","default":["appointmentDate"],"x-constraint":{"single":true},"items":{"type":"string","enum":["appointmentDate","closeDate","courseTitle","examTitle"]}},"description":"Key to sort by","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDistributionReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/sessionRequests":{"get":{"summary":"Session Requests","operationId":"getV1InstallsInstallsidReportsSessionrequests","description":"Returns all message threads that have active session requests for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"studentFirstName","in":"query","schema":{"type":"string","description":"First Name of student"},"description":"First Name of student"},{"name":"studentLastName","in":"query","schema":{"type":"string","description":"Last Name of student"},"description":"Last Name of student"},{"name":"studentEmail","in":"query","schema":{"type":"string","description":"Email of Student"},"description":"Email of Student"},{"name":"proctorFirstName","in":"query","schema":{"type":"string","description":"First Name of Proctor"},"description":"First Name of Proctor"},{"name":"proctorLastName","in":"query","schema":{"type":"string","description":"Last Name of Proctor"},"description":"Last Name of Proctor"},{"name":"courseSid","in":"query","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid"},{"name":"examSid","in":"query","schema":{"type":"string","description":"Exam Sid","pattern":"^EX[a-f0-9]{32}$"},"description":"Exam Sid"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Key to sort by","default":["createdDate"],"x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate","lastMessageDate","confirmedDate","confirmedDateExpiration"]}},"description":"Key to sort by","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionRequestReportResponse"}}}}}}},"/v1/installs/{installSid}/reports/unscheduledLearners":{"get":{"summary":"Unscheduled Learners","operationId":"getV1InstallsInstallsidReportsUnscheduledlearners","description":"Returns a paginated list of students who have not yet scheduled their exam sessions.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"offset","in":"query","schema":{"type":"integer","description":"Offset for pagination","minimum":0},"description":"Offset for pagination"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","default":50,"minimum":0},"description":"Number of items to return"},{"name":"courseSid","in":"query","schema":{"type":"string","description":"Course Sid","pattern":"^CU[a-f0-9]{32}$"},"description":"Course Sid"},{"name":"courseOfferingSid","in":"query","schema":{"type":"string","description":"Course Offering Sid","pattern":"^CO[a-f0-9]{32}$"},"description":"Course Offering Sid"},{"name":"courseTitle","in":"query","schema":{"type":"string","description":"Course Title"},"description":"Course Title"},{"name":"courseCode","in":"query","schema":{"type":"string","description":"Course code"},"description":"Course code"},{"name":"examTitle","in":"query","schema":{"type":"string","description":"Exam title"},"description":"Exam title"},{"name":"learnerFirstName","in":"query","schema":{"type":"string","description":"learner first name"},"description":"learner first name"},{"name":"learnerLastName","in":"query","schema":{"type":"string","description":"Learners last name"},"description":"Learners last name"},{"name":"learnerEmail","in":"query","schema":{"type":"string","description":"Learners email"},"description":"Learners email"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnscheduledLearnersReportResponse"}}}}}}},"/v1/proctors/{proctorSid}/reports/calendarCapacity":{"get":{"summary":"Calendar Capacity","operationId":"getV1ProctorsProctorsidReportsCalendarcapacity","description":"Returns appointment availability and capacity data for the specified calendar.","parameters":[{"name":"proctorSid","in":"path","schema":{"type":"string","description":"Proctor Account Sid","pattern":"^PA[a-f0-9]{32}$"},"description":"Proctor Account Sid","required":true},{"name":"calendarSid","in":"query","schema":{"type":"string","description":"Calendar Sid"},"description":"Calendar Sid","required":true},{"name":"startDate","in":"query","schema":{"type":"string","description":"Start date for availability range","x-format":{"isoDate":true}},"description":"Start date for availability range","required":true},{"name":"endDate","in":"query","schema":{"type":"string","description":"End date for availability range","x-format":{"isoDate":true}},"description":"End date for availability range","required":true},{"name":"duration","in":"query","schema":{"type":"integer","description":"Duration in minutes, defaults to 120","default":120},"description":"Duration in minutes, defaults to 120"}],"tags":["Reports"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/proctors/{proctorSid}/reports/examList":{"get":{"summary":"Proctor Exam Details","operationId":"getV1ProctorsProctorsidReportsExamlist","description":"Returns detailed exam information for the specified proctor account.","parameters":[{"name":"proctorSid","in":"path","schema":{"type":"string","description":"Proctor Account Sid","pattern":"^PA[a-f0-9]{32}$"},"description":"Proctor Account Sid","required":true},{"name":"examWindowStart","in":"query","schema":{"type":"string","description":"Starting range of exam","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Starting range of exam"},{"name":"examWindowEnd","in":"query","schema":{"type":"string","description":"Ending range of exam","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Ending range of exam"},{"name":"courseTitle","in":"query","schema":{"type":"string","description":"Course Title"},"description":"Course Title"},{"name":"examTitle","in":"query","schema":{"type":"string","description":"Exam title"},"description":"Exam title"},{"name":"installSid","in":"query","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Key to sort by","default":["accountName","courseTitle","examTitle"],"x-constraint":{"single":true},"items":{"type":"string","enum":["accountName","courseTitle","examTitle","createdDate"]}},"description":"Key to sort by","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"}],"tags":["Reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExamDetailsReportResponse"}}}}}}},"/v1/proctors/{proctorSid}/session-accommodations":{"get":{"summary":"Session Accommodations","operationId":"getV1ProctorsProctorsidSessionaccommodations","description":"Returns session accommodation data for the specified proctor account.","parameters":[{"name":"proctorSid","in":"path","schema":{"type":"string","description":"Proctor Sid","pattern":"^PA[a-f0-9]{32}$"},"description":"Proctor Sid","required":true},{"name":"name","in":"query","schema":{"type":"string","description":"Student name"},"description":"Student name"},{"name":"location","in":"query","schema":{"type":"string","description":"Proctor location name"},"description":"Proctor location name"},{"name":"appointmentEndDate","in":"query","schema":{"type":"string","description":"appointment end date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"appointment end date, must provide open date with it"},{"name":"appointmentStartDate","in":"query","schema":{"type":"string","description":"appointment start data","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"appointment start data"},{"name":"email","in":"query","schema":{"type":"string","description":"student email"},"description":"student email"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Offset for pagination","minimum":0},"description":"Offset for pagination"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to returnd","default":50,"minimum":0},"description":"Number of items to returnd"},{"name":"endDate","in":"query","schema":{"type":"string","description":"Exam Close date, must provide open date with it","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"Exam Close date, must provide open date with it"}],"tags":["Reports"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/timeZones":{"get":{"summary":"List Time Zones","operationId":"getV1Timezones","description":"Returns a paginated list of supported time zones.<br/><br/>Supports sorting by `createdDate` and pagination via `offset` and `limit`.","parameters":[{"name":"offset","in":"query","schema":{"type":"integer","description":"Id to get next portion of query data. For 1st query should pass as empty","minimum":0},"description":"Id to get next portion of query data. For 1st query should pass as empty"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Sort keys","x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate"]}},"description":"Sort keys","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Sort order","default":"ASC","enum":["ASC","DESC"]},"description":"Sort order"}],"tags":["Time Zones"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeZoneListResponse"}}}}}}},"/v1/installs/{installSid}/users":{"get":{"summary":"List Users","operationId":"getV1InstallsInstallsidUsers","description":"Returns a paginated list of users for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"admin","in":"query","schema":{"type":"boolean","description":"Filter admin user"},"description":"Filter admin user"},{"name":"offset","in":"query","schema":{"type":"integer","description":"Result offset","minimum":0},"description":"Result offset"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of items to return","minimum":0},"description":"Number of items to return"},{"name":"sortKeys","in":"query","schema":{"type":"array","description":"Keys to sort the data","default":["createdDate"],"x-constraint":{"single":true},"items":{"type":"string","enum":["createdDate","lastName","firstName"]}},"description":"Keys to sort the data","style":"form","explode":true},{"name":"sortOrder","in":"query","schema":{"type":"string","description":"Order of sorting","default":"ASC","enum":["ASC","DESC"]},"description":"Order of sorting"},{"name":"firstName","in":"query","schema":{"type":"string","description":"First Name"},"description":"First Name"},{"name":"lastName","in":"query","schema":{"type":"string","description":"Last Name"},"description":"Last Name"},{"name":"email","in":"query","schema":{"type":"string","description":"Email","x-format":{"email":true}},"description":"Email"},{"name":"sisId","in":"query","schema":{"type":"string","description":"SIS Id"},"description":"SIS Id"},{"name":"lmsId","in":"query","schema":{"type":"string","description":"LMS Id"},"description":"LMS Id"},{"name":"apiId","in":"query","schema":{"type":"string","description":"API Id"},"description":"API Id"},{"name":"externalId","in":"query","schema":{"type":"string","description":"External Id"},"description":"External Id"}],"tags":["User"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListResponse"}}}}}},"post":{"summary":"Create User","operationId":"postV1InstallsInstallsidUsers","description":"Creates a new user for the specified install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true}],"tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"/v1/installs/{installSid}/users/{userSid}":{"put":{"summary":"Update Admin User","operationId":"putV1InstallsInstallsidUsersUsersid","description":"Updates admin-specific fields for the specified user within the install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"userSid","in":"path","schema":{"type":"string","description":"User Sid","pattern":"^US[a-f0-9]{32}$"},"description":"User Sid","required":true}],"tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserUpdate"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete User","operationId":"deleteV1InstallsInstallsidUsersUsersid","description":"Deletes the specified user from the install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"userSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^US[a-f0-9]{32}$"},"description":"Install Sid","required":true}],"tags":["User"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/installs/{installSid}/users/{userSid}/profile":{"get":{"summary":"Get User Profile","operationId":"getV1InstallsInstallsidUsersUsersidProfile","description":"Returns the user profile for the specified user within the install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"userSid","in":"path","schema":{"type":"string","description":"User Sid","pattern":"^US[a-f0-9]{32}$"},"description":"User Sid","required":true}],"tags":["User"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}}}},"put":{"summary":"Update User Profile","operationId":"putV1InstallsInstallsidUsersUsersidProfile","description":"Updates the user profile for the specified user within the install.","parameters":[{"name":"installSid","in":"path","schema":{"type":"string","description":"Install Sid","pattern":"^AI[a-f0-9]{32}$"},"description":"Install Sid","required":true},{"name":"userSid","in":"path","schema":{"type":"string","description":"User Sid","pattern":"^US[a-f0-9]{32}$"},"description":"User Sid","required":true}],"tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}}}}}},"x-alt-definitions":{"role":{"type":"string","description":"User role in the course, defaults to \"learner\".","default":"learner","enum":["learner","instructor"]},"ProvisionEnrollment":{"type":"object","description":"Optional enrollment details. If not passed and the user is being created, they will be enrolled as a learner.","properties":{"role":{"$ref":"#/x-alt-definitions/role"}}}}}