Create Study - Synap API (Beta)

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

Study

Example:

Study

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "type": "Study",
        "attributes": {
            "selfPracticeSetupQuizMode": "practice",
            "selfPracticeSetupMaxQuestions": 0,
            "selfPracticeSetupMasteryLevels": [
                "unseen"
            ],
            "selfPracticeSetupTagSetId": "string",
            "selfPracticeSetupRandomise": true,
            "selfPracticeSetupTagFilters": {},
            "spacedLearningIntensityLevel": "Low",
            "spacedLearningStateIsActive": true
        },
        "relationships": {
            "items": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "StudyItem"
                    }
                ]
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (Study)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Study

Example:

Study

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Study",
        "attributes": {
            "totalStudyItems": 0,
            "totalQuestions": 0,
            "totalAnsweredQuestions": 0,
            "knowledgeCoverage": 0,
            "competencyScore": 0,
            "masteryLevel": "unseen",
            "studyItemOverviews": [
                {
                    "studyItemId": "string",
                    "type": "string",
                    "objectData": {
                        "className": "string",
                        "id": "string",
                        "label": "string",
                        "slug": "string",
                        "imageUrl": "string"
                    },
                    "isAttempted": true,
                    "totalQuestions": 0,
                    "totalAnsweredQuestions": 0,
                    "knowledgeCoverage": 0,
                    "competencyScore": 0,
                    "masteryLevel": "unseen",
                    "masteryDivisions": [
                        {
                            "level": "unseen",
                            "label": "string",
                            "totalQuestions": 0,
                            "percentageOfTotal": 0
                        }
                    ]
                }
            ],
            "masteryDivisions": [
                {
                    "level": "unseen",
                    "label": "string",
                    "totalQuestions": 0,
                    "percentageOfTotal": 0
                }
            ],
            "studyOverviewUpdatedAt": "2019-08-24T14:15:22Z",
            "selfPracticeSetupQuizMode": "practice",
            "selfPracticeSetupMaxQuestions": 0,
            "selfPracticeSetupMasteryLevels": [
                "unseen"
            ],
            "selfPracticeSetupTagSetId": "string",
            "selfPracticeSetupRandomise": true,
            "selfPracticeSetupTagFilters": {},
            "spacedLearningIntensityLevel": "Low",
            "spacedLearningNextDue": "2019-08-24T14:15:22Z",
            "spacedLearningMissedStreak": 0,
            "spacedLearningLatestTestCreatedAt": "2019-08-24T14:15:22Z",
            "spacedLearningStateIsActive": true,
            "spacedLearningStateWaiting": true,
            "spacedLearningStateTestReady": true,
            "spacedLearningStateHasAttempt": true,
            "spacedLearningStateStatusMessage": "string"
        },
        "relationships": {
            "latestQuiz": {
                "data": {
                    "id": "FID001",
                    "type": "Quiz"
                }
            },
            "latestAttempt": {
                "data": {
                    "id": "FID001",
                    "type": "Attempt"
                }
            },
            "items": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "StudyItem"
                    }
                ]
            },
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409