Update PlayerShortAnswerResponse

PATCH

/player-short-answer-responses/{object_id}

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (PlayerShortAnswerResponse)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

PlayerShortAnswerResponse

Example:

PlayerShortAnswerResponse

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerShortAnswerResponse",
        "attributes": {
            "status": "unanswered",
            "mediaStemPlaybackCount": 0,
            "answer": "string"
        },
        "relationships": {
            "feedbackImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "section": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerSection"
                }
            },
            "emqGroup": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerEmqGroup"
                }
            },
            "audioStem": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/player-short-answer-responses/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "PlayerShortAnswerResponse",
        "attributes": {
            "status": "unanswered",
            "mediaStemPlaybackCount": 0,
            "answer": "string"
        },
        "relationships": {
            "feedbackImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "section": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerSection"
                }
            },
            "emqGroup": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerEmqGroup"
                }
            },
            "audioStem": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (PlayerShortAnswerResponse)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

PlayerShortAnswerResponse

Example:

PlayerShortAnswerResponse

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerShortAnswerResponse",
        "attributes": {
            "status": "unanswered",
            "resultsStatus": "correct",
            "questionType": "audioRecording",
            "questionReferenceId": "string",
            "questionReferenceDoi": "string",
            "name": "string",
            "leadIn": "string",
            "stem": "string",
            "timerDurationMs": 0,
            "hideStemImage": true,
            "layout": "swimLane",
            "mediaStemType": "audio",
            "mediaStemPlaybackCount": 0,
            "audioStemPlayBackLimit": 0,
            "audioStemAutoPlay": true,
            "audioStemDisableProgression": true,
            "audioStemHideOptions": true,
            "audioStemAutoAdvance": "afterDefinedTime",
            "audioStemAdvanceEnforceFullTime": true,
            "audioStemAutoAdvanceDelay": 0,
            "audioStemDisableControls": true,
            "hideStemDuration": 0,
            "feedback": "string",
            "credit": 0,
            "penalty": 0,
            "maxPoints": 0,
            "points": 0,
            "markingOutcome": "correct",
            "answer": "string",
            "caseMatch": true,
            "disableSpellcheck": 0
        },
        "relationships": {
            "feedbackImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "section": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerSection"
                }
            },
            "emqGroup": {
                "data": {
                    "id": "FID001",
                    "type": "PlayerEmqGroup"
                }
            },
            "audioStem": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:21

Get PlayerShortAnswerResponse

Get PlayerSingleChoiceResponse