Create a Chapter - Aladia API

This endpoint creates a chapter using courseId.

Returns:

Newly created chapter

{ "id": "14074adb6dfab642739664da", "courseId": "fac1a6da588adc00cab087d5", "name": "Chapter 1", "description": "Chapter 1 description", "dates": { "startDate": "2004-07-27T12:54:06.443Z", "endDate": "2053-11-12T22:22:52.269Z" }, "lectures": [ "fb3ee7b41aff46e5500a31b8" ], "completion": { "chapterId": "6662c783d003f900eb646083", "completions": [], "average": 0 }, "status": "draft", "lecturesDuration": 97421, "createdAt": "2058-01-22T18:01:59.500Z", "updatedAt": "2051-11-28T08:52:38.085Z" }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

courseId

string

required

Header Params

apikey

string

optional

Example:

Body Params application/json

name

string

required

Chapter name

description

string

optional

Chapter description

cycles

object (cycles.model)

optional

Chapter dates

dates

object (dates.model)

required

string

optional

cycle identifier uuid

lecturesDuration

integer

optional

Total chapter lectures duration

mandatory

boolean

optional

is chapter mandatory?

suspension

string

optional

chapter suspension status

Examples

Responses

🟢201Created

application/json

Body

string

required

Primary key

courseId

string

optional

Course id

name

string

required

Chapter name

description

string

optional

Chapter description

dates

object (dates.model)

optional

Chapter dates

startDate

string

optional

Start date

endDate

string

optional

End date

lectures

array[string]

optional

Chapter lectures

lecturesDuration

integer

optional

Total chapter lectures duration

status

string

optional

course status

mandatory

boolean

optional

is chapter mandatory?

createdAt

string

optional

date

updatedAt

string

optional

date

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error