{
"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"
}
}
}
}
}
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"
}
}
}
}
}'
{
"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"
}
}
}
}
}