Update MobileResponse

PATCH

/mobile/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 (MobileResponse)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

MobileResponse

Example:

MobileResponse

attributes

object

optional

relationships

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "MobileResponse",
        "attributes": {
            "questionType": "audioRecording",
            "status": "string",
            "leadIn": "string",
            "stem": "string",
            "feedback": "string",
            "emqInstructions": "string",
            "emqFeedback": "string",
            "options": [
                {}
            ],
            "chosenOptions": [
                {}
            ],
            "correctOptions": [
                {}
            ],
            "outcome": "string"
        },
        "relationships": null
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/mobile/responses/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "MobileResponse",
        "attributes": {
            "questionType": "audioRecording",
            "status": "string",
            "leadIn": "string",
            "stem": "string",
            "feedback": "string",
            "emqInstructions": "string",
            "emqFeedback": "string",
            "options": [
                {}
            ],
            "chosenOptions": [
                {}
            ],
            "correctOptions": [
                {}
            ],
            "outcome": "string"
        },
        "relationships": null
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (MobileResponse)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

MobileResponse

Example:

MobileResponse

attributes

object

optional

relationships

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "MobileResponse",
        "attributes": {
            "questionType": "audioRecording",
            "status": "string",
            "leadIn": "string",
            "stem": "string",
            "feedback": "string",
            "emqInstructions": "string",
            "emqFeedback": "string",
            "options": [
                {}
            ],
            "chosenOptions": [
                {}
            ],
            "correctOptions": [
                {}
            ],
            "outcome": "string"
        },
        "relationships": null
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

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

Get MobileResponse

Get Session