Update MarkableResponse

PATCH

/markable-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 (MarkableResponse)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

MarkableResponse

Example:

MarkableResponse

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "MarkableResponse",
        "attributes": {
            "outcome": "correct",
            "credit": 0,
            "penalty": 0,
            "markSchemeCriterion": [
                {
                    "label": "string",
                    "maxCredits": 0,
                    "description": "string",
                    "credit": 0
                }
            ],
            "markSchemeCustomMarkingEnabled": true,
            "markSchemeCustomMarkingMaxCredits": 0,
            "markSchemeCustomMarkingstrategy": "cap",
            "candidateFeedback": "string",
            "markersNotes": "string"
        },
        "relationships": {
            "response": {
                "data": {
                    "id": "FID001",
                    "type": "Response"
                }
            },
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/markable-responses/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "MarkableResponse",
        "attributes": {
            "outcome": "correct",
            "credit": 0,
            "penalty": 0,
            "markSchemeCriterion": [
                {
                    "label": "string",
                    "maxCredits": 0,
                    "description": "string",
                    "credit": 0
                }
            ],
            "markSchemeCustomMarkingEnabled": true,
            "markSchemeCustomMarkingMaxCredits": 0,
            "markSchemeCustomMarkingstrategy": "cap",
            "candidateFeedback": "string",
            "markersNotes": "string"
        },
        "relationships": {
            "response": {
                "data": {
                    "id": "FID001",
                    "type": "Response"
                }
            },
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (MarkableResponse)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

MarkableResponse

Example:

MarkableResponse

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "MarkableResponse",
        "attributes": {
            "maxPoints": 0,
            "outcome": "correct",
            "points": 0,
            "credit": 0,
            "penalty": 0,
            "markSchemeCriterion": [
                {
                    "label": "string",
                    "maxCredits": 0,
                    "description": "string",
                    "credit": 0
                }
            ],
            "markSchemeCustomMarkingEnabled": true,
            "markSchemeCustomMarkingMaxCredits": 0,
            "markSchemeCustomMarkingstrategy": "cap",
            "markerEntries": [
                {
                    "entryIndex": 0,
                    "markerId": "string",
                    "marker": {
                        "id": "string",
                        "name": "string",
                        "profileImageURL": "string"
                    },
                    "marks": {},
                    "timestamp": "string"
                }
            ],
            "questionData": {},
            "isCorrect": true,
            "options": [
                {}
            ],
            "chosenOptions": [
                {}
            ],
            "correctOptions": [
                {}
            ],
            "candidateFeedback": "string",
            "markersNotes": "string",
            "sessionType": "provisional",
            "sessionStatus": "waiting"
        },
        "relationships": {
            "response": {
                "data": {
                    "id": "FID001",
                    "type": "Response"
                }
            },
            "attempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "candidate": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

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

Get MarkableResponse

List MarkableResponses