- Getting Started
- Authentication
- Error Handling
- Rate Limits
- Versioning
- Security
- Proctor Integration
- API Reference
- AccessPolicy
- User
- Create AccountClosureRequest
- Create AccountClosure
- Confirm account closure by patching with a confirmation token, received via email from the create action.
- Create EmailVerificationRequest
- Create EmailVerification
- Update EmailVerification
- Create ExternalExamSitting
- List ExternalExamSittings
- Update ExternalExamSitting
- Create InviteExport
- List Invites
- Get Invite
- Update Invite
- Create LearningRecord export
- Create LearningRecord
- List LearningRecords
- Get LearningRecord
- Update LearningRecord
- Delete LearningRecord
- Get App Login QR Code
- Create MarketingConsent
- Delete MarketingConsent
- Create PasswordResetRequest
- Create PasswordReset
- Update PasswordReset
- Get Session Context
- Get UserAccount
- List UserEngagement
- Create UserPassword
- Register User
- Get UserStats
- List Users
- Get User
- Update User
- Delete User
- Assignment
- Create AssignmentGroupCourseVersion
- List AssignmentGroupCourseVersions
- Create AssignmentGroupDataExport
- Get AssignmentGroupHeadlineInsight
- Create AssignmentGroup
- Get AssignmentGroup
- Update AssignmentGroup
- Delete AssignmentGroup
- Get AssignmentHeadlineInsight
- Create AssignmentManualReview
- Create AssignmentRevocation
- Delete AssignmentRevocation
- List Assignments
- Attempt
- Create AttemptLock
- Delete AttemptLock
- Get AttemptMarkSession
- List AttemptMarkSessions
- Create AttemptMarkerEntry
- Create AttemptMarksSubmission
- Create AttemptOverride
- List AttemptOverrides
- Get AttemptPlayerState
- Create AttemptRevocation
- Delete AttemptRevocation
- List AttemptSchedules
- Get AttemptSchedule
- Update AttemptSchedule
- Create AttemptSitting
- Create AttemptSubmission
- List Attempt Tag Labels
- Create AttemptTimerReset
- List AttemptTimers
- Get AttemptTimer
- Update AttemptTimer
- Create Attempt
- List Attempts
- Get Attempt
- Assign Markers
- Unassign Markers
- Assign Moderating Markers
- Unassign Moderating Markers
- Assign Backreaders
- Unassign Backreaders
- Assign Escalating Markers
- Unassign Escalating Markers
- Assign Auditing Markers
- Unassign Auditing Markers
- Assign Provisional Markers
- Unassign Provisional Markers
- Update Attempt Responses
- List EnrichedAttemptOptions
- List EnrichedAttempts
- Create ExamPreview
- Create ExportEnrichedAttempt
- Get MarkableResponse
- Update MarkableResponse
- List MarkableResponses
- Get PlayerAttempt
- Update PlayerAttempt
- Delete PlayerAttempt
- Get Response
- Update Response
- Get Response
- Update Response
- Get Response
- Update Response
- Get Response
- Update Response
- Get Response
- Update Response
- Get Response
- Update Response
- Get Response
- Update Response
- Get Response
- Update Response
- Get Response
- Update Response
- Get PlayerSection
- Update PlayerSection
- Get Response
- Update Response
- Get Response
- Update Response
- Get QuestionMarkSession
- Exams
- Create AttemptRevokeReversalPOST
- List AttemptRevokeReversalsGET
- Get AttemptRevokeReversalGET
- Update AttemptRevokeReversalPATCH
- Delete AttemptRevokeReversalDELETE
- Get ExamAttemptHeadlineInsightGET
- Create ExamClosurePOST
- Get ExamHallGET
- List ExamClosuresGET
- List ExamQuestionStatsGET
- Get ExamClosureGET
- Create ExamQuestionStatsExportPOST
- Update ExamClosurePATCH
- Create ExamV2POST
- Delete ExamClosureDELETE
- Find ExamV2sGET
- Get ExamV2GET
- Update ExamV2PATCH
- Delete ExamV2DELETE
- Get ExamScheduleGET
- Create Internal Markers GroupPOST
- Update ExamSchedulePATCH
- Set Shared Markers GroupPATCH
- Create ExamSectionPOST
- Create Internal Moderating Markers GroupPOST
- Get ExamSectionGET
- Set Shared Moderating Markers GroupPATCH
- Update ExamSectionPATCH
- Set Shared Escalating Markers GroupPATCH
- Delete ExamSectionDELETE
- Set Shared Auditing Markers GroupPATCH
- Create ExamTargetQuizSetupValidationPOST
- Create Internal Escalating Markers GroupPOST
- Get ExamTestTagBreakdownGET
- Create Internal Auditing Markers GroupPOST
- Create Internal BackReading Markers GroupPOST
- Set Shared BackReading Markers GroupPATCH
- Update Exam SectionPATCH
- Creates a new draft version of the underlying quizPOST
- Discards the current draft quiz and replaces it with the latest published version.PATCH
- Sets a quiz as the current published version. New attempts for this exam will use the publishedVersion quiz.PATCH
- Create ExamineeNotificationPOST
- List MarkersInboxItemsGET
- Creates a new draft version of the underlying quizPOST
- Creates a new draft version of the underlying quizDELETE
- Get ExamGET
- Update ExamPATCH
- Delete ExamDELETE
- Create ExamPOST
- Create Internal Markers GroupPOST
- Set Shared Markers GroupPATCH
- Create Internal Moderating Markers GroupPOST
- Set Shared Moderating Markers GroupPATCH
- Update Exam SectionPATCH
- AttributeConfig
- Authentication
- Create ADFS AuthenticationOption
- Get ADFS AuthenticationOption
- Update ADFS AuthenticationOption
- Delete ADFS AuthenticationOption
- Create Auth0 AuthenticationOption
- Get Auth0 AuthenticationOption
- Update Auth0 AuthenticationOption
- Delete Auth0 AuthenticationOption
- Create JWT AuthenticationOption
- Get JWT AuthenticationOption
- Update JWT AuthenticationOption
- Delete JWT AuthenticationOption
- Get Local AuthenticationOption
- Update Local AuthenticationOption
- Create LTI1.3 AuthenticationOption
- Get LTI1.3 AuthenticationOption
- Update LTI1.3 AuthenticationOption
- Delete LTI1.3 AuthenticationOption
- Create SAML AuthenticationOption
- Get SAML AuthenticationOption
- Update SAML AuthenticationOption
- Delete SAML AuthenticationOption
- List AuthenticationOptions
- Create BotSession
- Create PersonalAccessToken
- List PersonalAccessTokens
- Update PersonalAccessToken
- Delete PersonalAccessToken
- List PublicAuthenticationOptions
- Get Token
- Create ZapierApiKey
- List ZapierApiKeys
- Update ZapierApiKey
- Delete ZapierApiKey
- JobQueue
- BotUser
- Certificate
- ChartJS
- Content Management
- Collections
- Get CollectionItemNote
- Create Annotation
- List Annotations
- Get Annotation
- Update Annotation
- Delete Annotation
- Add collection access to a user group
- Delete collection access
- Create CollectionFolder
- List CollectionFolders
- Get CollectionFolder
- Update CollectionFolder
- Delete CollectionFolder
- Reorder CollectionFolder Items
- Create CollectionSubFolder
- Get CollectionSubFolder
- Update CollectionSubFolder
- Delete CollectionSubFolder
- Reorder CollectionSubFolder Items
- Create CollectionItemAudio
- List CollectionItems - use generic CollectionItem
- Get CollectionItemAudio
- Update CollectionItemAudio
- Delete CollectionItemAudio
- Get CollectionItemDocument
- Update CollectionItemDocument
- Delete CollectionItemDocument
- Create CollectionItemDocument
- Create CollectionItemEmbed
- List CollectionItems - use generic CollectionItem
- Get CollectionItemEmbed
- Update CollectionItemEmbed
- Delete CollectionItemEmbed
- Create CollectionItemNote
- List CollectionItems - use generic CollectionItem
- Get CollectionItemNote
- Update CollectionItemNote
- Delete CollectionItemNote
- Create CollectionItemQuiz
- List CollectionItems - use generic CollectionItem
- Get CollectionItemQuiz
- Update CollectionItemQuiz
- Delete CollectionItemQuiz
- Create CollectionItemVideo
- List CollectionItems - use generic CollectionItem
- Get CollectionItemVideo
- Update CollectionItemVideo
- Delete CollectionItemVideo
- Create CollectionItemZip
- List CollectionItems - use generic CollectionItem
- Get CollectionItemZip
- Update CollectionItemZip
- Delete CollectionItemZip
- List CollectionItems
- List CollectionMocks
- Create a CollectionProgress
- List CollectionProgresses
- Update a CollectionProgress
- Get CollectionTagBreakdown
- List Collections
- Create Collection
- Get Collection
- Update Collection
- Delete Collection
- Reorder Collection Folders
- Reorder Collection Items
- Create Highlight
- List Highlights
- Get Highlight
- Update Highlight
- Delete Highlight
- Library
- Course
- Create CourseFolder
- List CourseFolders
- Get CourseFolder
- Update CourseFolder
- Delete CourseFolder
- Update CourseFolder Items
- Create CourseItemAudio
- List CourseItems - use generic CourseItem
- Get CourseItemAudio
- Update CourseItemAudio
- Delete CourseItemAudio
- Create CourseItemDocument
- List CourseItems - use generic CourseItem
- Get CourseItemDocument
- Update CourseItemDocument
- Delete CourseItemDocument
- Create CourseItemEmbed
- List CourseItems - use generic CourseItem
- Get CourseItemEmbed
- Update CourseItemEmbed
- Delete CourseItemEmbed
- Create CourseItemNote
- List CourseItems - use generic CourseItem
- Get CourseItemNote
- Update CourseItemNote
- Delete CourseItemNote
- Create CourseItemQuiz
- List CourseItems - use generic CourseItem
- Get CourseItemQuiz
- Update CourseItemQuiz
- Delete CourseItemQuiz
- Create CourseItemScorm
- List CourseItems - use generic CourseItem
- Get CourseItemScorm
- Update CourseItemScorm
- Delete CourseItemScorm
- Create CourseItemSurvey
- List CourseItems - use generic CourseItem
- Get CourseItemSurvey
- Update CourseItemSurvey
- Delete CourseItemSurvey
- Create CourseItemTextEntry
- List CourseItems - use generic CourseItem
- Get CourseItemTextEntry
- Update CourseItemTextEntry
- Delete CourseItemTextEntry
- Create CourseItemUpload
- List CourseItems - use generic CourseItem
- Get CourseItemUpload
- Update CourseItemUpload
- Delete CourseItemUpload
- Create CourseItemVideo
- List CourseItems - use generic CourseItem
- Get CourseItemVideo
- Update CourseItemVideo
- Delete CourseItemVideo
- Create CourseItemZip
- List CourseItems - use generic CourseItem
- Get CourseItemZip
- Update CourseItemZip
- Delete CourseItemZip
- List CourseItems
- Create Course
- Get Course
- Update Course
- Delete Course
- Reorder Course Folders
- Reorder Course Items
- Quiz
- Create EmqExport
- Create EmqGroupImportValidation
- Create EmqGroupImport
- Create GenerateTestJob.
- Get GenerateTestJob.
- Generate Quiz
- Create QuestionExport
- Create QuestionImportValidation
- Create QuestionImport background job
- Create QuizEmqGroup
- Get QuizEmqGroup
- Update QuizEmqGroup
- Delete QuizEmqGroup
- Update quiz section questions.
- Get QuizPdfExport
- Create QuizQuestionAudioRecording
- List QuizQuestionAudioRecording
- Get QuizQuestionAudioRecording
- Update QuizQuestionAudioRecording
- Delete QuizQuestionAudioRecording
- Create QuizQuestionClozeDragAndDrop
- List QuizQuestionClozeDragAndDrop
- Get QuizQuestionClozeDragAndDrop
- Update QuizQuestionClozeDragAndDrop
- Delete QuizQuestionClozeDragAndDrop
- Create QuizQuestionClozeDropDown
- List QuizQuestionClozeDropDown
- Get QuizQuestionClozeDropDown
- Update QuizQuestionClozeDropDown
- Delete QuizQuestionClozeDropDown
- Create QuizQuestionClozeText
- List QuizQuestionClozeText
- Get QuizQuestionClozeText
- Update QuizQuestionClozeText
- Delete QuizQuestionClozeText
- Create QuizQuestionFileUpload
- List QuizQuestionFileUpload
- Get QuizQuestionFileUpload
- Update QuizQuestionFileUpload
- Delete QuizQuestionFileUpload
- Create QuizQuestionFreeText
- List QuizQuestionFreeText
- Get QuizQuestionFreeText
- Update QuizQuestionFreeText
- Delete QuizQuestionFreeText
- Create QuizQuestionInformational
- List QuizQuestionInformational
- Get QuizQuestionInformational
- Update QuizQuestionInformational
- Delete QuizQuestionInformational
- Create QuizQuestionMultipleCorrect
- List QuizQuestionMultipleCorrect
- Get QuizQuestionMultipleCorrect
- Update QuizQuestionMultipleCorrect
- Delete QuizQuestionMultipleCorrect
- Create QuizQuestionRanked
- List QuizQuestionRanked
- Get QuizQuestionRanked
- Update QuizQuestionRanked
- Delete QuizQuestionRanked
- Creates a new QuizQuestionShortAnswer.
- Find a set of QuizQuestionShortAnswer.
- Fetch a specific QuizQuestionShortAnswer.
- Update fields on a specific QuizQuestionShortAnswer.
- Delete a specific QuizQuestionShortAnswer.
- Create QuizQuestionSingleCorrect
- List QuizQuestionSingleCorrect
- Get QuizQuestionSingleCorrect
- Update QuizQuestionSingleCorrect
- Delete QuizQuestionSingleCorrect
- Create QuizSection
- List QuizSections
- Get QuizSection
- Update QuizSection
- Delete QuizSection
- Update quiz section questions.
- Add quiz section questions.
- Update source quizz relations on a specific Quiz.
- Create QuizSetupValidation
- Get QuizTagBreakdown
- Create Quiz
- Get Quiz
- Update Quiz
- Delete Quiz
- Update Quiz Questions
- Update Quiz Sections.
- Update source content quiz relations on a specific Quiz.
- Update source settings quiz relation on a specific Quiz. Only applicable for static quizzes.
- Get Test
- Delete Test
- List Tests
- Proctor
- File
- Flag
- GenerateAccount
- Notifications
- Integrations
- Mfa
- Billing
- Portal
- Scorm
- Search
- Survey
- TipSuggestion
- UserGroup
- Create UserGroupExport
- Create UserGroupLinkAccess
- List UserGroupLinkSettings
- Create UserGroupLinkSetting
- Get UserGroupLinkSetting
- Update UserGroupLinkSetting
- Validate UserGroupLink
- Get UserGroupLink
- Create UserGroup
- List UserGroups
- Get UserGroup
- Update UserGroup
- Delete UserGroup
- Add Users to UserGroup
- Remove Users from UserGroup
- Create UserImport
- List UserTypes
- Get UserGroup
- Update UserGroup
- Audit
- MarkingEntry
- MarkingSession
- Insights
- Marking
- Shop
- Create CheckoutSession
- Get CheckoutSession
- Update CheckoutSession
- Create PortalStore
- List PortalStores
- Get PortalStore
- Update PortalStore
- Delete PortalStore
- Create ProductList
- List ProductLists
- Get ProductList
- Update ProductList
- Delete ProductList
- Add Products
- Remove Products
- Create Product
- List Products
- Get Product
- Update Product
- Delete Product
- Get StoreOffer
- Revision
- Mobile
- Create MobileAttempt
- Find MobileAttempts
- Get MobileAttempt
- Update MobileAttempt
- Create MobileCollectionItem
- List MobileCollectionItems
- Get MobileCollectionItem
- Update MobileCollectionItem
- Delete MobileCollectionItem
- List MobileCollections
- Get MobileCollection
- List MobileResponses
- Get MobileResponse
- Update MobileResponse
- Get MobileSession
- Get MobileSpacedLearning
- Update MobileSpacedLearning
- Update Study items
- Update Study items
- Create MobileUser
- Get MobileUser
- Get result config for attemptGET
Get ExamV2
Staging
Staging
GET
/exam-v-2s/{object_id}
Exams
Request
Path Params
object_id
stringÂ
required
Example:
FID001
Query Params
include
array[string]
optional
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-stage.synap.ac/v3/exam-v-2s/'
Responses
🟢200OK
application/vnd.api+json
Body
data
object (Exam-V-2)Â
required
id
stringÂ
required
Example:
FID001
type
enum<string>Â
required
Allowed value:
Exam-V-2
Example:
Exam-V-2
attributes
objectÂ
optional
relationships
objectÂ
optional
included
array[object (GenericResource) {4}]Â
optional
id
stringÂ
optional
Example:
FID001
type
stringÂ
optional
Example:
_User
attributes
objectÂ
optional
relationships
objectÂ
optional
Example
{
"data": {
"id": "FID001",
"type": "Exam-V-2",
"attributes": {
"createdAt": "string",
"updatedAt": "string",
"name": "string",
"isDynamic": true,
"isSectioned": true,
"shortDescription": "string",
"preExamInstructions": "string",
"markingDoubleEnabled": true,
"markingDoubleAllocation": "manual",
"markingDoubleMinMarkers": 0,
"markingDoubleSequence": "parallel",
"markingBlindProvisionalMarker": true,
"markingBlindModeratingMarker": true,
"markingBlindEscalationMarker": true,
"markingBlindBackReadingMarker": true,
"markingBlindAuditingMarker": true,
"markingBlindIsolate": true,
"markerConcealmentProvisional": true,
"markerConcealmentModerating": true,
"markerConcealmentEscalation": true,
"markerConcealmentAuditing": true,
"markingEscalationEnabled": true,
"markingEscalationReasons": [
{
"slug": "string",
"label": "string",
"description": "string"
}
],
"markingBackReadingEnabled": true,
"markingAuditingEnabled": true,
"markingResolutionEnabled": true,
"notificationAutomateEmails": true,
"hideFromCandidateList": true,
"markingModeratingMarkerAllocation": "manual",
"markingProvisionalMarkerAllocation": "manual",
"ipAllowList": [
"string"
],
"lockedByDefault": true,
"resumeSameSession": true,
"resumeAllowed": true,
"attr": {},
"isArchived": true,
"mutexLockKey": "string",
"mutexLockExpiresAt": "string",
"mutexLockType": "full",
"testVersions": {}
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"portal": {
"data": {
"id": "FID001",
"type": "Portal"
}
},
"userGroup": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"markers": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"moderatingMarkers": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"escalatingMarkers": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"auditingMarkers": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"backReadingMarkers": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
},
"setupJob": {
"data": {
"id": "FID001",
"type": "BackgroundJob"
}
},
"coverImage": {
"data": {
"id": "FID001",
"type": "File"
}
},
"publishedVersion": {
"data": {
"id": "FID001",
"type": "Quiz"
}
},
"currentVersion": {
"data": {
"id": "FID001",
"type": "Quiz"
}
}
}
},
"included": [
{
"id": "FID001",
"type": "_User",
"attributes": {},
"relationships": {
"property1": {
"data": {
"id": "FID001",
"type": "_User"
},
"links": {
"self": "string",
"related": "string"
},
"meta": {}
},
"property2": {
"data": {
"id": "FID001",
"type": "_User"
},
"links": {
"self": "string",
"related": "string"
},
"meta": {}
}
}
}
]
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠422Parameter Error
Modified at 2025-04-17 15:00:11