Create Lesson

POST$BEEDEEZ_API/v1/lessons/create

Create Lesson

Create a Lesson

Request Body — REQUIRED

playMode string

Possible values: [standard, battle, adaptive]

categoryIds string[]

IDs of the categories this lesson belongs to

trackIds string[]

IDs of the tracks this lesson belongs to

level string

Possible values: [beginning, intermediary, expert]

images object[]

Publicly accessible URLs of the images of the lesson

type string

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string

URL of the image

image string

Publicly accessible URL of the image of the lesson

notions object[]

Notions of the lesson

exitQuizz object

questions object[]

Questions of the quiz

choicesOrderType string

Possible values: [ordered, random]

choices object[]

Choices of the question

value double

Value of the choice

choiceAnswer string

Answer of the choice

good boolean

Good choice

title string

Title of the choice

allowedAttempts double

Allowed attempts of the question

type string — REQUIRED

Possible values: [simple, swipecards, image-map, label-matching, multiple, truefalse, checkbox, order, gap-fill, satisfaction, evaluation, free-text, free-text-image-b64, free-number]

explanation string — REQUIRED

Explanation of the answer

title string — REQUIRED

Title of the question

type string

Possible values: [question-list, evaluation, life, survey, diagnostic, game, iterative, useCase]

lifeNumber double

Number of life of the quiz

entryQuizz object

questions object[]

Questions of the quiz

choicesOrderType string

Possible values: [ordered, random]

choices object[]

Choices of the question

value double

Value of the choice

choiceAnswer string

Answer of the choice

good boolean

Good choice

title string

Title of the choice

allowedAttempts double

Allowed attempts of the question

type string — REQUIRED

explanation string — REQUIRED

Explanation of the answer

title string — REQUIRED

Title of the question

type string

Possible values: [question-list, evaluation, life, survey, diagnostic, game, iterative, useCase]

lifeNumber double

Number of life of the quiz

iconsPreview object[]

Icons preview of the notion

type string

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string

URL of the image

contents object[] — REQUIRED

Contents of the notion

videoContent object

Video content of the lesson

thumbnail string

url string — REQUIRED

flashCardContent object[]

Flash card content of the lesson

backContent object — REQUIRED

images object[]

type string

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string

URL of the image

image string

text string — REQUIRED

frontContent object — REQUIRED

images object[]

type string

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string

URL of the image

image string

text string — REQUIRED

icons object[]

Publicly accessible URLs of the images of the lesson

type string

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string

URL of the image

duration double

Duration of the content

standardContent string

Content of the content card (markdown format accepted)

type string — REQUIRED

Possible values: [standard, flashCards, video, infographic]

Type of the content

name string — REQUIRED

Name of the content

description string — REQUIRED

Description of the notion

title string — REQUIRED

Title of the notion

status string — REQUIRED

Possible values: [saved, submit, online, refused, deleted, draft]

visibility string — REQUIRED

Possible values: [public, private]

summary string — REQUIRED

Summary of the lesson

title string — REQUIRED

Title of the lesson

id string

Responses

200

Schema — OPTIONAL

playMode string — OPTIONAL

Possible values: [standard, battle, adaptive]

categoryIds string[] — OPTIONAL

IDs of the categories this lesson belongs to

trackIds string[] — OPTIONAL

IDs of the tracks this lesson belongs to

level string — OPTIONAL

Possible values: [beginning, intermediary, expert]

images object[] — OPTIONAL

Publicly accessible URLs of the images of the lesson

type string — OPTIONAL

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string — OPTIONAL

URL of the image

image string — OPTIONAL

Publicly accessible URL of the image of the lesson

notions object[] — OPTIONAL

Notions of the lesson

exitQuizz object — OPTIONAL

questions object[] — OPTIONAL

Questions of the quiz

choicesOrderType string — OPTIONAL

Possible values: [ordered, random]

choices object[] — OPTIONAL

Choices of the question

value double — OPTIONAL

Value of the choice

choiceAnswer string — OPTIONAL

Answer of the choice

good boolean — OPTIONAL

Good choice

title string — OPTIONAL

Title of the choice

allowedAttempts double — OPTIONAL

Allowed attempts of the question

type string

explanation string

Explanation of the answer

title string

Title of the question

type string — OPTIONAL

Possible values: [question-list, evaluation, life, survey, diagnostic, game, iterative, useCase]

lifeNumber double — OPTIONAL

Number of life of the quiz

entryQuizz object — OPTIONAL

questions object[] — OPTIONAL

Questions of the quiz

choicesOrderType string — OPTIONAL

Possible values: [ordered, random]

choices object[] — OPTIONAL

Choices of the question

value double — OPTIONAL

Value of the choice

choiceAnswer string — OPTIONAL

Answer of the choice

good boolean — OPTIONAL

Good choice

title string — OPTIONAL

Title of the choice

allowedAttempts double — OPTIONAL

Allowed attempts of the question

type string

explanation string

Explanation of the answer

title string

Title of the question

type string — OPTIONAL

Possible values: [question-list, evaluation, life, survey, diagnostic, game, iterative, useCase]

lifeNumber double — OPTIONAL

Number of life of the quiz

iconsPreview object[] — OPTIONAL

Icons preview of the notion

type string — OPTIONAL

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string — OPTIONAL

URL of the image

contents object[]

Contents of the notion

videoContent object — OPTIONAL

Video content of the lesson

thumbnail string — OPTIONAL

url string

flashCardContent object[] — OPTIONAL

Flash card content of the lesson

backContent object

images object[] — OPTIONAL

type string — OPTIONAL

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string — OPTIONAL

URL of the image

image string — OPTIONAL

text string

frontContent object

images object[] — OPTIONAL

type string — OPTIONAL

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string — OPTIONAL

URL of the image

image string — OPTIONAL

text string

icons object[] — OPTIONAL

Publicly accessible URLs of the images of the lesson

type string — OPTIONAL

Possible values: [original, site, site-low-res, mobile, small, tiny, specific]

url string — OPTIONAL

URL of the image

duration double — OPTIONAL

Duration of the content

standardContent string — OPTIONAL

Content of the content card (markdown format accepted)

type string

Possible values: [standard, flashCards, video, infographic]

Type of the content

name string

Name of the content

description string

Description of the notion

title string

Title of the notion

status string

Possible values: [saved, submit, online, refused, deleted, draft]

visibility string

Possible values: [public, private]

summary string

Summary of the lesson

title string

Title of the lesson

id string — OPTIONAL

Authorization

AuthorizationBearer access tokenadmin scopeHow to get one

Request body

object

playModestringoptional

standardbattleadaptive

categoryIdsstring[]optional

IDs of the categories this lesson belongs to

trackIdsstring[]optional

IDs of the tracks this lesson belongs to

levelstringoptional

beginningintermediaryexpert

imagesobject[]optional

Publicly accessible URLs of the images of the lesson

typestringoptional

originalsitesite-low-resmobilesmalltinyspecific

urlstringoptional

URL of the image

imagestringoptional

Publicly accessible URL of the image of the lesson

notionsobject[]optional

Notions of the lesson

exitQuizzobjectoptional

questionsobject[]optional

Questions of the quiz

choicesOrderTypestringoptional

orderedrandom

choicesobject[]optional

Choices of the question

valuedoubleoptional

Value of the choice

choiceAnswerstringoptional

Answer of the choice

goodbooleanoptional

Good choice

titlestringoptional

Title of the choice

allowedAttemptsdoubleoptional

Allowed attempts of the question

typestringrequired

simpleswipecardsimage-maplabel-matchingmultipletruefalsecheckboxordergap-fillsatisfactionevaluationfree-textfree-text-image-b64free-number

explanationstringrequired

Explanation of the answer

titlestringrequired

Title of the question

typestringoptional

question-listevaluationlifesurveydiagnosticgameiterativeuseCase

lifeNumberdoubleoptional

Number of life of the quiz

entryQuizzobjectoptional

questionsobject[]optional

Questions of the quiz

choicesOrderTypestringoptional

orderedrandom

choicesobject[]optional

Choices of the question

valuedoubleoptional

Value of the choice

choiceAnswerstringoptional

Answer of the choice

goodbooleanoptional

Good choice

titlestringoptional

Title of the choice

allowedAttemptsdoubleoptional

Allowed attempts of the question

typestringrequired

simpleswipecardsimage-maplabel-matchingmultipletruefalsecheckboxordergap-fillsatisfactionevaluationfree-textfree-text-image-b64free-number

explanationstringrequired

Explanation of the answer

titlestringrequired

Title of the question

typestringoptional

question-listevaluationlifesurveydiagnosticgameiterativeuseCase

lifeNumberdoubleoptional

Number of life of the quiz

iconsPreviewobject[]optional

Icons preview of the notion

typestringoptional

originalsitesite-low-resmobilesmalltinyspecific

urlstringoptional

URL of the image

contentsobject[]required

Contents of the notion

videoContentobjectoptional

Video content of the lesson

thumbnailstringoptional

urlstringrequired

flashCardContentobject[]optional

Flash card content of the lesson

backContentobjectrequired

imagesobject[]optional

typestringoptional

originalsitesite-low-resmobilesmalltinyspecific

urlstringoptional

URL of the image

imagestringoptional

textstringrequired

frontContentobjectrequired

imagesobject[]optional

typestringoptional

originalsitesite-low-resmobilesmalltinyspecific

urlstringoptional

URL of the image

imagestringoptional

textstringrequired

iconsobject[]optional

Publicly accessible URLs of the images of the lesson

typestringoptional

originalsitesite-low-resmobilesmalltinyspecific

urlstringoptional

URL of the image

durationdoubleoptional

Duration of the content

standardContentstringoptional

Content of the content card (markdown format accepted)

typestringrequired

Type of the content

standardflashCardsvideoinfographic

namestringrequired

Name of the content

descriptionstringrequired

Description of the notion

titlestringrequired

Title of the notion

statusstringrequired

savedsubmitonlinerefuseddeleteddraft

visibilitystringrequired

publicprivate

summarystringrequired

Summary of the lesson

titlestringrequired

Title of the lesson

idstringoptional

Response

200 OKobject

playModestring

standardbattleadaptive

categoryIdsstring[]

IDs of the categories this lesson belongs to

trackIdsstring[]

IDs of the tracks this lesson belongs to

levelstring

beginningintermediaryexpert

imagesobject[]

Publicly accessible URLs of the images of the lesson

typestring

originalsitesite-low-resmobilesmalltinyspecific

urlstring

URL of the image

imagestring

Publicly accessible URL of the image of the lesson

notionsobject[]

Notions of the lesson

exitQuizzobject

questionsobject[]

Questions of the quiz

choicesOrderTypestring

orderedrandom

choicesobject[]

Choices of the question

valuedouble

Value of the choice

choiceAnswerstring

Answer of the choice

goodboolean

Good choice

titlestring

Title of the choice

allowedAttemptsdouble

Allowed attempts of the question

typestring

simpleswipecardsimage-maplabel-matchingmultipletruefalsecheckboxordergap-fillsatisfactionevaluationfree-textfree-text-image-b64free-number

explanationstring

Explanation of the answer

titlestring

Title of the question

typestring

question-listevaluationlifesurveydiagnosticgameiterativeuseCase

lifeNumberdouble

Number of life of the quiz

entryQuizzobject

questionsobject[]

Questions of the quiz

choicesOrderTypestring

orderedrandom

choicesobject[]

Choices of the question

valuedouble

Value of the choice

choiceAnswerstring

Answer of the choice

goodboolean

Good choice

titlestring

Title of the choice

allowedAttemptsdouble

Allowed attempts of the question

typestring

simpleswipecardsimage-maplabel-matchingmultipletruefalsecheckboxordergap-fillsatisfactionevaluationfree-textfree-text-image-b64free-number

explanationstring

Explanation of the answer

titlestring

Title of the question

typestring

question-listevaluationlifesurveydiagnosticgameiterativeuseCase

lifeNumberdouble

Number of life of the quiz

iconsPreviewobject[]

Icons preview of the notion

typestring

originalsitesite-low-resmobilesmalltinyspecific

urlstring

URL of the image

contentsobject[]

Contents of the notion

videoContentobject

Video content of the lesson

thumbnailstring

urlstring

flashCardContentobject[]

Flash card content of the lesson

backContentobject

imagesobject[]

typestring

originalsitesite-low-resmobilesmalltinyspecific

urlstring

URL of the image

imagestring

textstring

frontContentobject

imagesobject[]

typestring

originalsitesite-low-resmobilesmalltinyspecific

urlstring

URL of the image

imagestring

textstring

iconsobject[]

Publicly accessible URLs of the images of the lesson

typestring

originalsitesite-low-resmobilesmalltinyspecific

urlstring

URL of the image

durationdouble

Duration of the content

standardContentstring

Content of the content card (markdown format accepted)

typestring

Type of the content

standardflashCardsvideoinfographic

namestring

Name of the content

descriptionstring

Description of the notion

titlestring

Title of the notion

statusstring

savedsubmitonlinerefuseddeleteddraft

visibilitystring

publicprivate

summarystring

Summary of the lesson

titlestring

Title of the lesson

idstring