This document is generated by Aladia.

Aladia API

Search a Chapter

Developing

GET

/courses/{courseId}/chapters/search

This endpoint filter the chapters using the chapter name.

Expected query parameters:

name: the term used to search and filter the chapter using the chapter name as a query

Returns:

An array of Chapters objects which partially match the query, inside a data property, as well as the pagination properties

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/courses//chapters/search?name&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

{
  "data": [
    {
      "id": "da9ed9ac7e642ccb4cb43bf9",
      "courseId": "88afcd0f1cc99ef30a8eb60f",
      "name": "Chapter 1",
      "description": "demand-driven",
      "dates": {
        "startDate": "2024-02-12T07:51:44.278Z",
        "endDate": "2094-03-03T14:17:22.201Z"
      },
      "lectures": [
        "b9877977aa5a7c7afccd5fdb"
      ],
      "lecturesDuration": 72767,
      "completion": {
        "chapterId": "6662c783d003f900eb646083",
        "completions": [],
        "average": 0
      },
      "status": "draft",
      "createdAt": "2038-02-24T08:08:38.259Z",
      "updatedAt": "2008-09-09T17:07:28.336Z"
    }
  ],
  "cursor": {
    "next": null,
    "prev": null,
    "totalItems": 1
  }
}

Request

Path Params

courseId

string

required

Query Params

name

string

optional

name

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

data

array[object (chapter.rto) {11}]

required

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

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

string

required

string

required

totalItems

integer

required

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error

Modified at 2025-04-08 15:41:05

List All Chapters

Delete a Chapter