Update PlayerSection - Synap API (Beta)

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (PlayerSection)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

PlayerSection

Example:

PlayerSection

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerSection",
        "attributes": {
            "status": "completed"
        },
        "relationships": {
            "responses": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "PlayerAudioResponse"
                    }
                ]
            },
            "instructionsAudioStem": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "outroAudioStem": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (PlayerSection)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

PlayerSection

Example:

PlayerSection

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerSection",
        "attributes": {
            "status": "completed",
            "position": 0,
            "title": "string",
            "questionsCompleted": 0,
            "questionsSkipped": 0,
            "timeStarted": "string",
            "timeCompleted": "string",
            "timeSpent": 0,
            "timerDuration": 0,
            "timerEnforced": true,
            "timerHidden": true,
            "instructionsTitle": "string",
            "instructionsBody": "string",
            "instructionsTimerDuration": 0,
            "instructionsTimerHidden": true,
            "instructionsEnforcedTimer": "afterAudioStarts",
            "instructionsTimeStarted": "string",
            "instructionsTimeCompleted": "string",
            "instructionsTimeSpentMs": 0,
            "outroTitle": "string",
            "outroBody": "string",
            "outroTimerDuration": 0,
            "outroTimerHidden": true,
            "outroEnforcedTimer": "afterAudioStarts",
            "outroTimeStarted": "string",
            "outroTimeCompleted": "string",
            "outroTimeSpentMs": 0,
            "instructionsAudioAutoAdvance": "afterDefinedTime",
            "instructionsAudioAutoAdvanceDelay": 0,
            "instructionsAudioAutoPlay": true,
            "instructionsAudioControlsDisabled": true,
            "outroAudioAutoAdvance": "afterDefinedTime",
            "outroAudioAutoAdvanceDelay": 0,
            "outroAudioAutoPlay": true,
            "outroAudioControlsDisabled": true
        },
        "relationships": {
            "responses": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "PlayerAudioResponse"
                    }
                ]
            },
            "instructionsAudioStem": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "outroAudioStem": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found