- 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 AttemptRevokeReversal
- List AttemptRevokeReversals
- Get AttemptRevokeReversal
- Update AttemptRevokeReversal
- Delete AttemptRevokeReversal
- Get ExamAttemptHeadlineInsight
- Create ExamClosure
- Get ExamHall
- List ExamClosures
- List ExamQuestionStats
- Get ExamClosure
- Create ExamQuestionStatsExport
- Update ExamClosure
- Create ExamV2
- Delete ExamClosure
- Find ExamV2s
- Get ExamV2
- Update ExamV2
- Delete ExamV2
- Get ExamSchedule
- Create Internal Markers Group
- Update ExamSchedule
- Set Shared Markers Group
- Create ExamSection
- Create Internal Moderating Markers Group
- Get ExamSection
- Set Shared Moderating Markers Group
- Update ExamSection
- Set Shared Escalating Markers Group
- Delete ExamSection
- Set Shared Auditing Markers Group
- Create ExamTargetQuizSetupValidation
- Create Internal Escalating Markers Group
- Get ExamTestTagBreakdown
- Create Internal Auditing Markers Group
- Create Internal BackReading Markers Group
- Set Shared BackReading Markers Group
- Update Exam Section
- Creates a new draft version of the underlying quiz
- Discards the current draft quiz and replaces it with the latest published version.
- Sets a quiz as the current published version. New attempts for this exam will use the publishedVersion quiz.
- Create ExamineeNotification
- List MarkersInboxItems
- Creates a new draft version of the underlying quiz
- Creates a new draft version of the underlying quiz
- Get Exam
- Update Exam
- Delete Exam
- Create Exam
- Create Internal Markers Group
- Set Shared Markers Group
- Create Internal Moderating Markers Group
- Set Shared Moderating Markers Group
- Update Exam Section
- 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 EmqExportPOST
- Create EmqGroupImportValidationPOST
- Create EmqGroupImportPOST
- Create GenerateTestJob.POST
- Get GenerateTestJob.GET
- Generate QuizPOST
- Create QuestionExportPOST
- Create QuestionImportValidationPOST
- Create QuestionImport background jobPOST
- Create QuizEmqGroupPOST
- Get QuizEmqGroupGET
- Update QuizEmqGroupPATCH
- Delete QuizEmqGroupDELETE
- Update quiz section questions.PATCH
- Get QuizPdfExportGET
- Create QuizQuestionAudioRecordingPOST
- List QuizQuestionAudioRecordingGET
- Get QuizQuestionAudioRecordingGET
- Update QuizQuestionAudioRecordingPATCH
- Delete QuizQuestionAudioRecordingDELETE
- Create QuizQuestionClozeDragAndDropPOST
- List QuizQuestionClozeDragAndDropGET
- Get QuizQuestionClozeDragAndDropGET
- Update QuizQuestionClozeDragAndDropPATCH
- Delete QuizQuestionClozeDragAndDropDELETE
- Create QuizQuestionClozeDropDownPOST
- List QuizQuestionClozeDropDownGET
- Get QuizQuestionClozeDropDownGET
- Update QuizQuestionClozeDropDownPATCH
- Delete QuizQuestionClozeDropDownDELETE
- Create QuizQuestionClozeTextPOST
- List QuizQuestionClozeTextGET
- Get QuizQuestionClozeTextGET
- Update QuizQuestionClozeTextPATCH
- Delete QuizQuestionClozeTextDELETE
- Create QuizQuestionFileUploadPOST
- List QuizQuestionFileUploadGET
- Get QuizQuestionFileUploadGET
- Update QuizQuestionFileUploadPATCH
- Delete QuizQuestionFileUploadDELETE
- Create QuizQuestionFreeTextPOST
- List QuizQuestionFreeTextGET
- Get QuizQuestionFreeTextGET
- Update QuizQuestionFreeTextPATCH
- Delete QuizQuestionFreeTextDELETE
- Create QuizQuestionInformationalPOST
- List QuizQuestionInformationalGET
- Get QuizQuestionInformationalGET
- Update QuizQuestionInformationalPATCH
- Delete QuizQuestionInformationalDELETE
- Create QuizQuestionMultipleCorrectPOST
- List QuizQuestionMultipleCorrectGET
- Get QuizQuestionMultipleCorrectGET
- Update QuizQuestionMultipleCorrectPATCH
- Delete QuizQuestionMultipleCorrectDELETE
- Create QuizQuestionRankedPOST
- List QuizQuestionRankedGET
- Get QuizQuestionRankedGET
- Update QuizQuestionRankedPATCH
- Delete QuizQuestionRankedDELETE
- Creates a new QuizQuestionShortAnswer.POST
- Find a set of QuizQuestionShortAnswer.GET
- Fetch a specific QuizQuestionShortAnswer.GET
- Update fields on a specific QuizQuestionShortAnswer.PATCH
- Delete a specific QuizQuestionShortAnswer.DELETE
- Create QuizQuestionSingleCorrectPOST
- List QuizQuestionSingleCorrectGET
- Get QuizQuestionSingleCorrectGET
- Update QuizQuestionSingleCorrectPATCH
- Delete QuizQuestionSingleCorrectDELETE
- Create QuizSectionPOST
- List QuizSectionsGET
- Get QuizSectionGET
- Update QuizSectionPATCH
- Delete QuizSectionDELETE
- Update quiz section questions.PATCH
- Add quiz section questions.POST
- Update source quizz relations on a specific Quiz.PATCH
- Create QuizSetupValidationPOST
- Get QuizTagBreakdownGET
- Create QuizPOST
- Get QuizGET
- Update QuizPATCH
- Delete QuizDELETE
- Update Quiz QuestionsPATCH
- Update Quiz Sections.PATCH
- Update source content quiz relations on a specific Quiz.PATCH
- Update source settings quiz relation on a specific Quiz. Only applicable for static quizzes.PATCH
- Get TestGET
- Delete TestDELETE
- List TestsGET
- 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
Update QuizQuestionFileUpload
Staging
Staging
PATCH
/quiz-question-file-upload/{object_id}
Quiz
Request
Path Params
object_id
stringÂ
required
Example:
FID001
Body Params application/vnd.api+json
data
object (QuizQuestionFileUpload)Â
required
id
stringÂ
required
Example:
FID001
type
enum<string>Â
required
Allowed value:
QuizQuestionFileUpload
Example:
QuizQuestionFileUpload
attributes
objectÂ
optional
relationships
objectÂ
optional
Example
{
"data": {
"id": "FID001",
"type": "QuizQuestionFileUpload",
"attributes": {
"stem": "string",
"name": "string",
"leadIn": "string",
"doi": "string",
"feedback": "string",
"attr": {},
"timerMs": 1000,
"layout": "topDown",
"markingCredit": 0,
"markingPartialCredit": 0,
"markingPenalty": 0,
"mediaStemType": "audio",
"audioStemAutoAdvance": "disabled",
"audioStemAutoAdvanceDelayMs": 0,
"audioStemAutoAdvanceEnforceFullTime": true,
"disableAudioStemControls": true,
"audioStemPlaybackLimit": 1,
"audioStemAutoPlay": true,
"audioStemDisableProgression": true,
"audioStemHideOptions": true,
"hideStemMs": 1000,
"markingAdditionalInfo": "string",
"markingResolutionEnabled": true,
"markingResolutionStrategy": "average",
"markingAgreementThresholdType": "percentageDiff",
"markingAgreementThresholdValue": 0,
"markSchemeEnabled": true,
"markSchemeCustomMarkingEnabled": true,
"markSchemeCustomMarkingMaxCredits": 0,
"markSchemeCustomMarkingstrategy": "scale",
"markSchemeCriterion": [
{
"slug": "string",
"label": "string",
"maxCredits": 0,
"description": "string",
"agreementThreshold": {
"type": "percentageDiff",
"value": 0
}
}
],
"inputLabel": "string"
},
"relationships": {
"emqGroup": {
"data": {
"id": "FID001",
"type": "QuizEmqGroup"
}
},
"quiz": {
"data": {
"id": "FID001",
"type": "Quiz"
}
},
"tags": {
"data": [
{
"id": "FID001",
"type": "Tag"
}
]
},
"section": {
"data": {
"id": "FID001",
"type": "QuizSection"
}
},
"audioStem": {
"data": {
"id": "FID001",
"type": "File"
}
},
"source": {}
}
}
}
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 PATCH 'https://api-stage.synap.ac/v3/quiz-question-file-upload/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw ''
Responses
🟢200OK
application/vnd.api+json
Body
data
object (QuizQuestionFileUpload)Â
optional
id
stringÂ
required
Example:
FID001
type
enum<string>Â
required
Allowed value:
QuizQuestionFileUpload
Example:
QuizQuestionFileUpload
attributes
objectÂ
optional
relationships
objectÂ
optional
Example
{
"data": {
"id": "FID001",
"type": "QuizQuestionFileUpload",
"attributes": {
"stem": "string",
"name": "string",
"leadIn": "string",
"doi": "string",
"feedback": "string",
"attr": {},
"timerMs": 1000,
"layout": "topDown",
"markingCredit": 0,
"markingPartialCredit": 0,
"markingPenalty": 0,
"mediaStemType": "audio",
"audioStemAutoAdvance": "disabled",
"audioStemAutoAdvanceDelayMs": 0,
"audioStemAutoAdvanceEnforceFullTime": true,
"disableAudioStemControls": true,
"audioStemPlaybackLimit": 1,
"audioStemAutoPlay": true,
"audioStemDisableProgression": true,
"audioStemHideOptions": true,
"hideStemMs": 1000,
"unreviewedFlags": 0,
"markingAdditionalInfo": "string",
"markingResolutionEnabled": true,
"markingResolutionStrategy": "average",
"markingAgreementThresholdType": "percentageDiff",
"markingAgreementThresholdValue": 0,
"markSchemeEnabled": true,
"markSchemeCustomMarkingEnabled": true,
"markSchemeCustomMarkingMaxCredits": 0,
"markSchemeCustomMarkingstrategy": "scale",
"markSchemeCriterion": [
{
"slug": "string",
"label": "string",
"maxCredits": 0,
"description": "string",
"agreementThreshold": {
"type": "percentageDiff",
"value": 0
}
}
],
"questionType": "fileUpload",
"inputLabel": "string"
},
"relationships": {
"emqGroup": {
"data": {
"id": "FID001",
"type": "QuizEmqGroup"
}
},
"quiz": {
"data": {
"id": "FID001",
"type": "Quiz"
}
},
"tags": {
"data": [
{
"id": "FID001",
"type": "Tag"
}
]
},
"section": {
"data": {
"id": "FID001",
"type": "QuizSection"
}
},
"audioStem": {
"data": {
"id": "FID001",
"type": "File"
}
},
"source": {
"data": {
"id": "FID001",
"type": "QuizQuestion"
}
}
}
}
}
🟢204No Content
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-04-17 15:00:11