Update PlayerImageHotspotResponse

PATCH

/player-image-hotspot-responses/{object_id}

Request

Path Params

Body Params application/vnd.api+json

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerImageHotspotResponse",
        "attributes": {
            "status": "unanswered",
            "mediaStemPlaybackCount": 0,
            "answer": {
                "x": 0,
                "y": 0,
                "matchedHotspotSlug": "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"
                }
            },
            "hotspotImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/player-image-hotspot-responses/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "PlayerImageHotspotResponse",
        "attributes": {
            "status": "unanswered",
            "mediaStemPlaybackCount": 0,
            "answer": {
                "x": 0,
                "y": 0,
                "matchedHotspotSlug": "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"
                }
            },
            "hotspotImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerImageHotspotResponse",
        "attributes": {
            "status": "unanswered",
            "resultsStatus": "correct",
            "questionType": "audioRecording",
            "questionReferenceId": "string",
            "questionReferenceDoi": "string",
            "name": "string",
            "leadIn": "string",
            "stem": "string",
            "timerDurationMs": 0,
            "hideStemImage": true,
            "layout": "swimLane",
            "scoreByChoice": true,
            "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": {
                "x": 0,
                "y": 0,
                "matchedHotspotSlug": "string"
            },
            "correctAnswers": [
                {
                    "slug": "string",
                    "label": "string",
                    "shape": "rect",
                    "coords": {
                        "centerX": 0,
                        "centerY": 0,
                        "width": 0,
                        "height": 0,
                        "rotation": 0
                    },
                    "credits": 0,
                    "penalties": 0,
                    "isCorrect": true
                }
            ]
        },
        "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"
                }
            },
            "hotspotImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-09-15 09:59:10

Get PlayerImageHotspotResponse

Get PlayerInformationalResponse