Create QuizQuestionVideoRecording

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

QuizQuestionVideoRecording

Example:

QuizQuestionVideoRecording

attributes

object

required

relationships

object

required

Example

{
    "data": {
        "type": "QuizQuestionVideoRecording",
        "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",
            "videoRecordingMaximumTimeMs": 3600000,
            "videoRecordingAllowDelete": true,
            "videoRecordingAllowReRecord": true,
            "videoRecordingAllowPause": true,
            "videoRecordingAllowEarlySubmission": true,
            "videoRecordingAutoRecording": false,
            "videoRecordingAutoRecordingDelayMs": 0,
            "videoRecordingAutoAdvance": "disabled",
            "videoRecordingAutoAdvanceDelayMs": 0
        },
        "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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/quiz-question-video-recording' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "QuizQuestionVideoRecording",
        "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",
            "videoRecordingMaximumTimeMs": 3600000,
            "videoRecordingAllowDelete": true,
            "videoRecordingAllowReRecord": true,
            "videoRecordingAllowPause": true,
            "videoRecordingAllowEarlySubmission": true,
            "videoRecordingAutoRecording": false,
            "videoRecordingAutoRecordingDelayMs": 0,
            "videoRecordingAutoAdvance": "disabled",
            "videoRecordingAutoAdvanceDelayMs": 0
        },
        "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": {}
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (QuizQuestionVideoRecording)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

QuizQuestionVideoRecording

Example:

QuizQuestionVideoRecording

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "QuizQuestionVideoRecording",
        "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": "videoRecording",
            "inputLabel": "string",
            "videoRecordingMaximumTimeMs": 1,
            "videoRecordingAllowDelete": true,
            "videoRecordingAllowReRecord": true,
            "videoRecordingAllowPause": true,
            "videoRecordingAllowEarlySubmission": true,
            "videoRecordingAutoRecording": true,
            "videoRecordingAutoRecordingDelayMs": 0,
            "videoRecordingAutoAdvance": "disabled",
            "videoRecordingAutoAdvanceDelayMs": 0
        },
        "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"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409