Get MobileCollectionItem - Synap API (Beta)

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (MobileCollectionItem)

required

id

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

MobileCollectionItem

Example:

MobileCollectionItem

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "MobileCollectionItem",
        "attributes": {
            "title": "string",
            "collectionItemType": "audio",
            "description": "string",
            "imageUrl": "string",
            "isPreviewOnly": true,
            "canStudy": true
        },
        "relationships": {
            "quiz": {
                "data": {
                    "id": "FID001",
                    "type": "MobileQuiz"
                }
            },
            "note": {
                "data": {
                    "id": "FID001",
                    "type": "MobileNote"
                }
            },
            "audio": {
                "data": {
                    "id": "FID001",
                    "type": "MobileAudioContent"
                }
            },
            "document": {
                "data": {
                    "id": "FID001",
                    "type": "MobileDocumentContent"
                }
            },
            "embed": {
                "data": {
                    "id": "FID001",
                    "type": "MobileEmbedContent"
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error