Update PlayerAttempt - 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 (PlayerAttempt)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

PlayerAttempt

Example:

PlayerAttempt

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerAttempt",
        "attributes": {
            "timeStarted": "string",
            "timeCompleted": "string",
            "examStatus": "enrolled",
            "status": "completed"
        },
        "relationships": {
            "test": {
                "data": {
                    "id": "FID001",
                    "type": "Test"
                }
            },
            "exam": {
                "data": {
                    "id": "FID001",
                    "type": "Exam-V-2"
                }
            },
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "audioInstructions": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "responses": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "PlayerAudioResponse"
                    }
                ]
            },
            "sections": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "PlayerSection"
                    }
                ]
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (PlayerAttempt)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

PlayerAttempt

Example:

PlayerAttempt

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "PlayerAttempt",
        "attributes": {
            "title": "string",
            "quizMode": "exam",
            "locked": true,
            "revoked": true,
            "timeStarted": "string",
            "timeCompleted": "string",
            "theme": "default",
            "fontSize": "xLarge",
            "pinnedMessage": "string",
            "disableNavigation": true,
            "disableControlPanel": true,
            "disableNotifications": true,
            "proctorEnabled": true,
            "proctorVendor": "internal",
            "proctorSessionId": "string",
            "examStatus": "enrolled",
            "status": "completed",
            "scheduleStatus": "active",
            "attr": {},
            "openTime": "string",
            "closeTime": "string",
            "credits": 0,
            "penalties": 0,
            "maxPoints": 0,
            "points": 0,
            "showAvailableMarks": true,
            "score": 0,
            "questionBreakdownDisplay": "full",
            "timerEnabled": true,
            "timerDuration": 0,
            "timerType": "questions",
            "enforceFullTime": true,
            "softTimer": true,
            "extraTimeMultiplier": 0,
            "features": [
                "bookmarking"
            ],
            "externalPlayer": "default",
            "disableCopying": true,
            "disablePasting": true,
            "disableRightClick": true,
            "labValues": "string",
            "markingPenaltiesEnabled": true,
            "instructionsEnabled": true,
            "instructionsTitle": "string",
            "instructionsBody": "string",
            "instructionsTimeStarted": "string",
            "instructionsTimeCompleted": "string",
            "instructionsTimerDurationMs": 1,
            "instructionsEnforcedTimer": "afterAudioStarts",
            "instructionsAudioAutoAdvance": "disabled",
            "instructionsAudioAutoAdvanceDelayMs": 0,
            "instructionsAudioAutoPlay": true,
            "instructionsDisableAudioControls": true
        },
        "relationships": {
            "test": {
                "data": {
                    "id": "FID001",
                    "type": "Test"
                }
            },
            "exam": {
                "data": {
                    "id": "FID001",
                    "type": "Exam-V-2"
                }
            },
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "audioInstructions": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "responses": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "PlayerAudioResponse"
                    }
                ]
            },
            "sections": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "PlayerSection"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found