- Getting Started
- Authentication
- Error Handling
- Versioning
- Security
- API Reference
- Access Policies
- Assignments
- Get AssignmentFolder
- Create AssignmentGroupCourseVersion
- List AssignmentGroupCourseVersions
- Create AssignmentGroupDataExport
- Get AssignmentGroupHeadlineInsight
- Create AssignmentGroup
- Get AssignmentGroup
- Update AssignmentGroup
- Delete AssignmentGroup
- Get AssignmentHeadlineInsight
- Get AssignmentItemAudio
- Update AssignmentItemAudio
- Get AssignmentItemDocument
- Update AssignmentItemDocument
- Get AssignmentItemEmbed
- Update AssignmentItemEmbed
- Get AssignmentItemNote
- Update AssignmentItemNote
- Create AssignmentItemPulse
- Get AssignmentItemQuiz
- Update AssignmentItemQuiz
- Get AssignmentItemScorm
- Update AssignmentItemScorm
- Get AssignmentItemSurvey
- Update AssignmentItemSurvey
- Get AssignmentItemTextEntry
- Update AssignmentItemTextEntry
- Get AssignmentItemUpload
- Update AssignmentItemUpload
- Get AssignmentItemVideo
- Update AssignmentItemVideo
- Get AssignmentItemZip
- Update AssignmentItemZip
- Create AssignmentManualReview
- Create AssignmentReattempt
- Create AssignmentReset
- Create AssignmentRevocation
- Delete AssignmentRevocation
- Get AssignmentScormResult
- Get Assignment
- Update Assignment
- List Assignments
- Attempts
- List AttemptCharts
- List AttemptInsights
- Create AttemptLock
- Delete AttemptLock
- Get AttemptMarkSession
- List AttemptMarkSessions
- Create AttemptMarkerEntry
- Create AttemptMarksSubmission
- Create AttemptOverride
- List AttemptOverrides
- Get AttemptPlayerState
- List AttemptResultConfigs
- List AttemptSchedules
- Get AttemptSchedule
- Update AttemptSchedule
- Create AttemptSitting
- Create AttemptSubmission
- List AttemptTagLabels
- Create AttemptTimerReset
- List AttemptTimers
- Get AttemptTimer
- Update AttemptTimer
- Create Attempt
- List Attempts
- Get Attempt
- Update Attempt
- Assign 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 PlayerAudioResponse
- Update PlayerAudioResponse
- Get PlayerClozeDragAndDropResponse
- Update PlayerClozeDragAndDropResponse
- Get PlayerClozeDropDownResponse
- Update PlayerClozeDropDownResponse
- Get PlayerClozeTextResponse
- Update PlayerClozeTextResponse
- Get PlayerEmqGroup
- Get PlayerFileUploadResponse
- Update PlayerFileUploadResponse
- Get PlayerFreeTextResponse
- Update PlayerFreeTextResponse
- Get PlayerInformationalResponse
- Update PlayerInformationalResponse
- Get PlayerMultipleChoiceResponse
- Update PlayerMultipleChoiceResponse
- Get PlayerRankedResponse
- Update PlayerRankedResponse
- Get PlayerSection
- Update PlayerSection
- Get PlayerShortAnswerResponse
- Update PlayerShortAnswerResponse
- Get PlayerSingleChoiceResponse
- Update PlayerSingleChoiceResponse
- Get PlayerVideoResponse
- Update PlayerAudioResponse
- Get QuestionMarkSession
- Auditing
- 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
- Activate MFA
- Get MfaConfig
- Create MFAConfig
- Create MfaDeactivation
- Create PersonalAccessToken
- List PersonalAccessTokens
- Update PersonalAccessToken
- Delete PersonalAccessToken
- List PublicAuthenticationOptions
- Get Token
- Delete own UserSession
- Create ZapierApiKey
- List ZapierApiKeys
- Update ZapierApiKey
- Delete ZapierApiKey
- Billing
- Certificates
- Collections
- Create AnnotationPOST
- List AnnotationsGET
- Get AnnotationGET
- Update AnnotationPATCH
- Delete AnnotationDELETE
- Create CollectionAccessPOST
- Delete CollectionAccessDELETE
- Create CollectionFolderPOST
- List CollectionFoldersGET
- Get CollectionFolderGET
- Update CollectionFolderPATCH
- Delete CollectionFolderDELETE
- Reorder CollectionFolder ItemsPATCH
- Create CollectionSubFolderPOST
- Get CollectionSubFolderGET
- Update CollectionSubFolderPATCH
- Delete CollectionSubFolderDELETE
- Reorder CollectionSubFolder ItemsPATCH
- Create CollectionItemAudioPOST
- List CollectionItemAudio (Use Generic)GET
- Get CollectionItemAudioGET
- Update CollectionItemAudioPATCH
- Delete CollectionItemAudioDELETE
- Get CollectionItemDocumentGET
- Update CollectionItemDocumentPATCH
- Delete CollectionItemDocumentDELETE
- Create CollectionItemDocumentPOST
- Create CollectionItemEmbedPOST
- List CollectionItemEmbeds (Use Generic)GET
- Get CollectionItemEmbedGET
- Update CollectionItemEmbedPATCH
- Delete CollectionItemEmbedDELETE
- Create CollectionItemNotePOST
- List CollectionItemNotes (Use Generic)GET
- Get CollectionItemNoteGET
- Update CollectionItemNotePATCH
- Delete CollectionItemNoteDELETE
- Create CollectionItemQuizPOST
- List CollectionItems - use generic CollectionItemGET
- Get CollectionItemQuizGET
- Update CollectionItemQuizPATCH
- Delete CollectionItemQuizDELETE
- Create CollectionItemVideoPOST
- List CollectionItems - use generic CollectionItemGET
- Get CollectionItemVideoGET
- Update CollectionItemVideoPATCH
- Delete CollectionItemVideoDELETE
- Create CollectionItemZipPOST
- List CollectionItems - use generic CollectionItemGET
- Get CollectionItemZipGET
- Update CollectionItemZipPATCH
- Delete CollectionItemZipDELETE
- List CollectionItemsGET
- List CollectionMocksGET
- Create CollectionProgressPOST
- List CollectionProgressesGET
- Update CollectionProgressPATCH
- List CollectionSubFoldersGET
- Get CollectionTagBreakdownGET
- List CollectionsGET
- Create CollectionPOST
- Get CollectionGET
- Update CollectionPATCH
- Delete CollectionDELETE
- Reorder Collection FoldersPATCH
- Reorder Collection ItemsPATCH
- Create HighlightPOST
- List HighlightsGET
- Get HighlightGET
- Update HighlightPATCH
- Delete HighlightDELETE
- Content Metadata
- Courses
- Create CourseFolder
- List CourseFolders
- Get CourseFolder
- Update CourseFolder
- Delete CourseFolder
- Update CourseFolder Items
- Create CourseItemAudio
- List CourseItemAudio (Use Generic)
- Get CourseItemAudio
- Update CourseItemAudio
- Delete CourseItemAudio
- Create CourseItemDocument
- List CourseItemDocument (Use Generic)
- Get CourseItemDocument
- Update CourseItemDocument
- Delete CourseItemDocument
- Create CourseItemEmbed
- List CourseItemEmbed (Use Generic)
- Get CourseItemEmbed
- Update CourseItemEmbed
- Delete CourseItemEmbed
- Create CourseItemNote
- List CourseItemNote (Use Generic)
- Get CourseItemNote
- Update CourseItemNote
- Delete CourseItemNote
- Create CourseItemQuiz
- List CourseItemQuiz (Use Generic)
- Get CourseItemQuiz
- Update CourseItemQuiz
- Delete CourseItemQuiz
- Create CourseItemScorm
- List CourseItemScorm (Use Generic)
- Get CourseItemScorm
- Update CourseItemScorm
- Delete CourseItemScorm
- Create CourseItemSurvey
- List CourseItemSurvey (Use Generic)
- Get CourseItemSurvey
- Update CourseItemSurvey
- Delete CourseItemSurvey
- Create CourseItemTextEntry
- List CourseItemTextEntry (Use Generic)
- Get CourseItemTextEntry
- Update CourseItemTextEntry
- Delete CourseItemTextEntry
- Create CourseItemUpload
- List CourseItemUpload (Use Generic)
- Get CourseItemUpload
- Update CourseItemUpload
- Delete CourseItemUpload
- Create CourseItemVideo
- List CourseItemVideo (Use Generic)
- Get CourseItemVideo
- Update CourseItemVideo
- Delete CourseItemVideo
- Create CourseItemZip
- List CourseItemZip (Use Generic)
- Get CourseItemZip
- Update CourseItemZip
- Delete CourseItemZip
- List CourseItems
- Create Course
- Get Course
- Update Course
- Delete Course
- Reorder Course Folders
- Reorder Course Items
- Exams
- Create AttemptRevokeReversal
- List AttemptRevokeReversals
- Get AttemptRevokeReversal
- Update AttemptRevokeReversal
- Delete AttemptRevokeReversal
- Get ExamAttemptHeadlineInsight
- Create ExamCandidateExport
- Get ExamHall
- List ExamQuestionStats
- Create ExamQuestionStatsExport
- Create ExamV2
- Find ExamV2s
- Get ExamV2
- Update ExamV2
- Delete ExamV2
- Create Internal Markers Group
- Set Shared Markers Group
- Create Internal Moderating Markers Group
- Set Shared Moderating Markers Group
- Set Shared Escalating Markers Group
- Set Shared Auditing Markers Group
- Create Internal Escalating Markers Group
- 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
- Insights
- Integrations
- Library
- Create ContentEmbedDatum
- Create Content
- Get Content
- Update Content
- Delete Content
- Create File
- Get File
- Get Note
- Delete Note
- Update Note
- Create Note
- Create ScormCourse
- Get ScormCourse
- Update ScormCourse
- Delete ScormCourse
- Create SurveyItem
- Get SurveyItem
- Update SurveyItem
- Delete SurveyItem
- Create SurveyPage
- Get SurveyPage
- Update SurveyPage
- Delete SurveyPage
- Update Survey Page Items
- Create SurveyResponse
- Create Survey
- Get Survey
- Update Survey
- Delete Survey
- Update Survey Pages
- Marking
- Mobile
- Create MobileAttempt
- List MobileAttempts
- Get MobileAttempt
- Update MobileAttempt
- Create MobileCollectionItem
- List MobileCollectionItems
- Get MobileCollectionItem
- Update MobileCollectionItem
- Delete MobileCollectionItem
- List Collections
- Get Collection
- List MobileResponses
- Get MobileResponse
- Update MobileResponse
- Get Session
- Get MobileSpacedLearning
- Update MobileSpacedLearning
- Add MobileStudyItems
- Remove MobileStudyItems
- Create MobileUser
- Get MobileUser
- Notifications
- Portals
- Proctoring
- Quizzes
- Create EmqGroupExport
- Create EmqGroupImportValidation
- Create EmqGroupImport
- Create GenerateTestJob
- Get GenerateTestJob
- Create GeneratedTest
- Create QuestionExport
- Create QuestionImportValidation
- Create QuestionImport
- 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
- Create QuizQuestionShortAnswer
- List QuizQuestionShortAnswer
- Get QuizQuestionShortAnswer
- Update QuizQuestionShortAnswer
- Delete QuizQuestionShortAnswer
- Create QuizQuestionSingleCorrect
- List QuizQuestionSingleCorrect
- Get QuizQuestionSingleCorrect
- Update QuizQuestionSingleCorrect
- Delete QuizQuestionSingleCorrect
- Create QuizQuestionVideoRecording
- List QuizQuestionVideoRecording
- Get QuizQuestionVideoRecording
- Update QuizQuestionVideoRecording
- Delete QuizQuestionVideoRecording
- Create QuizSection
- List QuizSections
- Get QuizSection
- Update QuizSection
- Delete QuizSection
- Update quiz section questions.
- Add quiz section questions.
- Create QuizSetupValidation
- Get QuizTagBreakdown
- Create Quiz
- Get Quiz
- Update Quiz
- Delete Quiz
- Update Quiz Questions
- Update Quiz Sections
- Update Quiz Content Sources
- Update Quiz Settings Source
- Get Test
- Delete Test
- List Tests
- Revision
- Search
- Shop
- Create CheckoutSession
- Get CheckoutSession
- Update CheckoutSession
- List LegacyAccessUpgradeOptions
- 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
- User Groups
- 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 UserType
- Update UserType
- User Feedback
- Users
- Create AccountClosureRequest
- Create AccountClosure
- Update AccountClosure
- Create BotUser
- List BotUsers
- List Documents
- Create EmailVerification
- Update EmailVerification
- Create ExternalExamSitting
- List ExternalExamSittings
- Update ExternalExamSitting
- Create GeneratedAccount
- Create InviteExport
- List Invites
- Get Invite
- Update Invite
- Create LearningRecordExport
- Create LearningRecord
- List LearningRecords
- Get LearningRecord
- Update LearningRecord
- Delete LearningRecord
- Get App Login QR Code
- Create MarketingConsent
- Delete MarketingConsent
- Create PasswordResetRequest
- Create PasswordReset
- Get PasswordReset
- Update PasswordReset
- Get Session Context
- Get UserAccount
- List UserEngagement
- Create UserPassword
- Create UserRegistration
- Get UserStat
- List Users
- Get User
- Update User
- Delete User
- Cookbook
Create Collection
POST
/collections
Collections
Request
Body Params application/vnd.api+json
data
objectÂ
required
type
enum<string>Â
required
Allowed value:
Collection
Example:
Collection
attributes
objectÂ
required
relationships
objectÂ
optional
Example
{
"data": {
"type": "Collection",
"attributes": {
"name": "string",
"description": "string",
"shortDescription": "string",
"settings": {
"takeTest": {},
"playerView": {
"enabled": true,
"hideOverviewPage": true
},
"trackedProgress": {
"enabled": true
},
"annotations": {
"enabled": true
},
"generatedAttempts": {
"enabled": true
},
"mocks": [
{
"id": "string",
"title": "string",
"filters": {},
"quizLength": 1,
"passScore": 0,
"examSittingAttrs": {}
}
],
"restrictedAccess": {
"label": "string"
},
"sorting": {
"prioritise": true
}
},
"attr": {},
"extraInformation": {},
"isArchived": true,
"generatedAttemptsEnabled": true,
"mocks": [
{
"id": "string",
"title": "string",
"filters": {
"weightingType": "absolute",
"filterRules": [
{
"weighting": 0,
"matchingRules": [
{
"tagId": "string",
"exclude": true
}
]
}
]
},
"quizLength": 1,
"passScore": 0,
"examSittingAttrs": {},
"timeInMs": 1
}
],
"annotationsEnabled": true,
"playerViewEnabled": true,
"playerViewHideOverviewPage": true,
"restrictedAccessLabel": "string",
"sortingPrioritise": true,
"takeTestSettings": {},
"instructionsEnabled": false,
"instructionsTitle": "string",
"instructionsBody": "string",
"instructionsTimerDurationMs": 1,
"instructionsEnforcedTimer": "afterAudioStarts",
"instructionsAudioAutoAdvance": "disabled",
"instructionsAudioAutoAdvanceDelayMs": 0,
"instructionsAudioAutoPlay": true,
"instructionsDisableAudioControls": true,
"markingCreditsPerQuestion": 1,
"markingPartialCreditsPerQuestion": 0,
"markingPenaltiesPerQuestion": 0,
"markingPenaltiesEnabled": false,
"grades": [
{
"label": "string",
"minScore": 0,
"isPass": true,
"description": "string"
}
],
"allowedModes": [
"practice"
],
"allowedLengths": [
"default"
],
"allowedPlayers": [
"default"
],
"allowedTagSets": [
"string"
],
"allowedFacets": [
"subject"
],
"calculatorEnabled": false,
"tagSelectionDisplayMode": "dropdown",
"allowMultipleTagSelection": false,
"excludeUntaggedQuestions": false,
"showMasteryFilters": false,
"calculatorType": "basic",
"securityDisableCopying": false,
"securityDisablePasting": false,
"securityDisableRightClick": false,
"navigationDisableNavigation": false,
"navigationDisableControlPanel": false,
"navigationDisableNotifications": false,
"softSectionsEnabled": false,
"shuffleSectionsEnabled": false,
"shuffleQuestions": "disabled",
"notepadEnabled": false,
"strikethroughEnabled": false,
"highlightingEnabled": false,
"bookmarkingEnabled": false,
"micSettingsEnabled": false,
"labValuesEnabled": false,
"labValuesHtml": "string",
"resumeLaterButtonEnabled": false,
"flaggingEnabled": false,
"showAvailableMarks": false,
"playerType": "default",
"theme": "default",
"fontSize": "medium",
"pinnedMessageDuringTest": "string",
"resultsMessageCompleted": "string",
"resultsMessageSettingHideTitle": false,
"resultsMetricScoreEnabled": true,
"resultsMetricTimeSpentEnabled": true,
"resultsMetricGradeEnabled": true,
"resultsMetricQuestionBreakdownDisplayLevel": "full",
"resultsMetricAnalyticsCohort": "test",
"resultsMetricCohortAverageEnabled": false,
"resultsMetricCohortPercentileEnabled": false,
"resultsMetricCohortScoreDistributionEnabled": false,
"resultsMetricTagBreakdownEnabled": true,
"resultsMetricTagProgressEnabled": true,
"resultsMetricTagProgressFacetsEnabled": {
"subject": true,
"topic": true,
"subtopic": true,
"skill": true,
"difficulty": true
},
"resultsEducatorViewAsAdminEnabled": true,
"timerEnabled": false,
"timerHidden": false,
"timerUseQuestions": true,
"timerUseSections": true,
"timerEnforceFullTime": true,
"timerTimeInMs": 1,
"timerExtraTimeMultiplier": 0,
"timerSoftTimer": true,
"trackedProgressEnabled": true
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"items": {
"data": [
{
"id": "FID001",
"type": "CollectionItem"
}
]
},
"folders": {
"data": [
{
"id": "FID001",
"type": "CollectionFolder"
}
]
},
"icon": {
"data": {
"id": "FID001",
"type": "File"
}
},
"coverImage": {
"data": {
"id": "FID001",
"type": "File"
}
},
"collectionAccess": {
"data": [
{
"id": "FID001",
"type": "CollectionAccess"
}
]
},
"instructionsAudio": {
"data": {
"id": "FID001",
"type": "File"
}
}
}
}
}
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 POST 'https://api.synap.ac/v3/collections' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"type": "Collection",
"attributes": {
"name": "string",
"description": "string",
"shortDescription": "string",
"settings": {
"takeTest": {},
"playerView": {
"enabled": true,
"hideOverviewPage": true
},
"trackedProgress": {
"enabled": true
},
"annotations": {
"enabled": true
},
"generatedAttempts": {
"enabled": true
},
"mocks": [
{
"id": "string",
"title": "string",
"filters": {},
"quizLength": 1,
"passScore": 0,
"examSittingAttrs": {}
}
],
"restrictedAccess": {
"label": "string"
},
"sorting": {
"prioritise": true
}
},
"attr": {},
"extraInformation": {},
"isArchived": true,
"generatedAttemptsEnabled": true,
"mocks": [
{
"id": "string",
"title": "string",
"filters": {
"weightingType": "absolute",
"filterRules": [
{
"weighting": 0,
"matchingRules": [
{
"tagId": "string",
"exclude": true
}
]
}
]
},
"quizLength": 1,
"passScore": 0,
"examSittingAttrs": {},
"timeInMs": 1
}
],
"annotationsEnabled": true,
"playerViewEnabled": true,
"playerViewHideOverviewPage": true,
"restrictedAccessLabel": "string",
"sortingPrioritise": true,
"takeTestSettings": {},
"instructionsEnabled": false,
"instructionsTitle": "string",
"instructionsBody": "string",
"instructionsTimerDurationMs": 1,
"instructionsEnforcedTimer": "afterAudioStarts",
"instructionsAudioAutoAdvance": "disabled",
"instructionsAudioAutoAdvanceDelayMs": 0,
"instructionsAudioAutoPlay": true,
"instructionsDisableAudioControls": true,
"markingCreditsPerQuestion": 1,
"markingPartialCreditsPerQuestion": 0,
"markingPenaltiesPerQuestion": 0,
"markingPenaltiesEnabled": false,
"grades": [
{
"label": "string",
"minScore": 0,
"isPass": true,
"description": "string"
}
],
"allowedModes": [
"practice"
],
"allowedLengths": [
"default"
],
"allowedPlayers": [
"default"
],
"allowedTagSets": [
"string"
],
"allowedFacets": [
"subject"
],
"calculatorEnabled": false,
"tagSelectionDisplayMode": "dropdown",
"allowMultipleTagSelection": false,
"excludeUntaggedQuestions": false,
"showMasteryFilters": false,
"calculatorType": "basic",
"securityDisableCopying": false,
"securityDisablePasting": false,
"securityDisableRightClick": false,
"navigationDisableNavigation": false,
"navigationDisableControlPanel": false,
"navigationDisableNotifications": false,
"softSectionsEnabled": false,
"shuffleSectionsEnabled": false,
"shuffleQuestions": "disabled",
"notepadEnabled": false,
"strikethroughEnabled": false,
"highlightingEnabled": false,
"bookmarkingEnabled": false,
"micSettingsEnabled": false,
"labValuesEnabled": false,
"labValuesHtml": "string",
"resumeLaterButtonEnabled": false,
"flaggingEnabled": false,
"showAvailableMarks": false,
"playerType": "default",
"theme": "default",
"fontSize": "medium",
"pinnedMessageDuringTest": "string",
"resultsMessageCompleted": "string",
"resultsMessageSettingHideTitle": false,
"resultsMetricScoreEnabled": true,
"resultsMetricTimeSpentEnabled": true,
"resultsMetricGradeEnabled": true,
"resultsMetricQuestionBreakdownDisplayLevel": "full",
"resultsMetricAnalyticsCohort": "test",
"resultsMetricCohortAverageEnabled": false,
"resultsMetricCohortPercentileEnabled": false,
"resultsMetricCohortScoreDistributionEnabled": false,
"resultsMetricTagBreakdownEnabled": true,
"resultsMetricTagProgressEnabled": true,
"resultsMetricTagProgressFacetsEnabled": {
"subject": true,
"topic": true,
"subtopic": true,
"skill": true,
"difficulty": true
},
"resultsEducatorViewAsAdminEnabled": true,
"timerEnabled": false,
"timerHidden": false,
"timerUseQuestions": true,
"timerUseSections": true,
"timerEnforceFullTime": true,
"timerTimeInMs": 1,
"timerExtraTimeMultiplier": 0,
"timerSoftTimer": true,
"trackedProgressEnabled": true
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"items": {
"data": [
{
"id": "FID001",
"type": "CollectionItem"
}
]
},
"folders": {
"data": [
{
"id": "FID001",
"type": "CollectionFolder"
}
]
},
"icon": {
"data": {
"id": "FID001",
"type": "File"
}
},
"coverImage": {
"data": {
"id": "FID001",
"type": "File"
}
},
"collectionAccess": {
"data": [
{
"id": "FID001",
"type": "CollectionAccess"
}
]
},
"instructionsAudio": {
"data": {
"id": "FID001",
"type": "File"
}
}
}
}
}'
Responses
🟢201Created
application/vnd.api+json
Body
data
object (Collection)Â
optional
id
stringÂ
required
Example:
FID001
type
enum<string>Â
required
Allowed value:
Collection
Example:
Collection
attributes
objectÂ
optional
relationships
objectÂ
optional
Example
{
"data": {
"id": "FID001",
"type": "Collection",
"attributes": {
"createdAt": "string",
"updatedAt": "string",
"name": "string",
"description": "string",
"shortDescription": "string",
"settings": {
"takeTest": {},
"playerView": {
"enabled": true,
"hideOverviewPage": true
},
"trackedProgress": {
"enabled": true
},
"annotations": {
"enabled": true
},
"generatedAttempts": {
"enabled": true
},
"mocks": [
{
"id": "string",
"title": "string",
"filters": {},
"quizLength": 1,
"passScore": 0,
"examSittingAttrs": {}
}
],
"restrictedAccess": {
"label": "string"
},
"sorting": {
"prioritise": true
}
},
"attr": {},
"extraInformation": {},
"isArchived": true,
"generatedAttemptsEnabled": true,
"mocks": [
{
"id": "string",
"title": "string",
"filters": {
"weightingType": "absolute",
"filterRules": [
{
"weighting": 0,
"matchingRules": [
{
"tagId": "string",
"exclude": true
}
]
}
]
},
"quizLength": 1,
"passScore": 0,
"examSittingAttrs": {},
"timeInMs": 1
}
],
"annotationsEnabled": true,
"playerViewEnabled": true,
"playerViewHideOverviewPage": true,
"restrictedAccessLabel": "string",
"sortingPrioritise": true,
"takeTestSettings": {},
"instructionsEnabled": true,
"instructionsTitle": "string",
"instructionsBody": "string",
"instructionsTimerDurationMs": 1,
"instructionsEnforcedTimer": "afterAudioStarts",
"instructionsAudioAutoAdvance": "disabled",
"instructionsAudioAutoAdvanceDelayMs": 0,
"instructionsAudioAutoPlay": true,
"instructionsDisableAudioControls": true,
"markingCreditsPerQuestion": 0,
"markingPartialCreditsPerQuestion": 0,
"markingPenaltiesPerQuestion": 0,
"markingPenaltiesEnabled": true,
"grades": [
{
"label": "string",
"minScore": 0,
"isPass": true,
"description": "string"
}
],
"allowedModes": [
"practice"
],
"allowedLengths": [
"default"
],
"allowedPlayers": [
"default"
],
"allowedTagSets": [
"string"
],
"allowedFacets": [
"subject"
],
"calculatorEnabled": true,
"tagSelectionDisplayMode": "dropdown",
"allowMultipleTagSelection": true,
"excludeUntaggedQuestions": true,
"showMasteryFilters": true,
"calculatorType": "basic",
"securityDisableCopying": true,
"securityDisablePasting": true,
"securityDisableRightClick": true,
"navigationDisableNavigation": true,
"navigationDisableControlPanel": true,
"navigationDisableNotifications": true,
"softSectionsEnabled": true,
"shuffleSectionsEnabled": true,
"shuffleQuestions": "disabled",
"notepadEnabled": true,
"strikethroughEnabled": true,
"highlightingEnabled": true,
"bookmarkingEnabled": true,
"micSettingsEnabled": true,
"labValuesEnabled": true,
"labValuesHtml": "string",
"resumeLaterButtonEnabled": true,
"flaggingEnabled": true,
"showAvailableMarks": true,
"playerType": "default",
"theme": "string",
"fontSize": "xSmall",
"pinnedMessageDuringTest": "string",
"resultsMessageCompleted": "string",
"resultsMessageSettingHideTitle": true,
"resultsMetricScoreEnabled": true,
"resultsMetricTimeSpentEnabled": true,
"resultsMetricGradeEnabled": true,
"resultsMetricQuestionBreakdownDisplayLevel": "full",
"resultsMetricAnalyticsCohort": "exam",
"resultsMetricCohortAverageEnabled": true,
"resultsMetricCohortPercentileEnabled": true,
"resultsMetricCohortScoreDistributionEnabled": true,
"resultsMetricTagBreakdownEnabled": true,
"resultsMetricTagProgressEnabled": true,
"resultsMetricTagProgressFacetsEnabled": {
"subject": true,
"topic": true,
"subtopic": true,
"skill": true,
"difficulty": true
},
"resultsEducatorViewAsAdminEnabled": true,
"timerEnabled": true,
"timerHidden": true,
"timerUseQuestions": true,
"timerUseSections": true,
"timerEnforceFullTime": true,
"timerTimeInMs": 1,
"timerExtraTimeMultiplier": 0,
"timerSoftTimer": true,
"trackedProgressEnabled": true
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"items": {
"data": [
{
"id": "FID001",
"type": "CollectionItem"
}
]
},
"folders": {
"data": [
{
"id": "FID001",
"type": "CollectionFolder"
}
]
},
"icon": {
"data": {
"id": "FID001",
"type": "File"
}
},
"coverImage": {
"data": {
"id": "FID001",
"type": "File"
}
},
"collectionAccess": {
"data": [
{
"id": "FID001",
"type": "CollectionAccess"
}
]
},
"instructionsAudio": {
"data": {
"id": "FID001",
"type": "File"
}
}
}
}
}
🟢202Accepted
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409409
Modified at 2025-07-08 10:51:21