Naar hoofdinhoud

Lessen

GET https://scintillating-wolf-799.eu-west-1.convex.site/v1/lessons

Lessen van één training, met hun volgorde en of er video bij zit. Een training die niet bij deze omgeving hoort geeft not_found, net als een training die niet bestaat.

Rechten: learning:read. Deze gegevens gaan over personen.

Lessen horen altijd bij één training, dus trainingId is verplicht. Je haalt eerst de trainingen op en gebruikt het id daaruit; een training die niet bij jouw omgeving hoort geeft dezelfde 404 als een training die niet bestaat.

Binnen een pagina staan de lessen op displayOrder, de volgorde die de training zelf aanhoudt. Haal je meerdere pagina's op, sorteer dan zelf over het geheel, want die volgorde geldt per pagina. Het veld moduleId zegt in welke module een les staat; lessen zonder module horen direct onder de training.

Het veld contentDripType zegt of een les meteen beschikbaar is of pas later. Bouw je een overzicht voor een lid, dan is dat het verschil tussen wat hij nu kan doen en wat er nog aankomt.

Parameters

Naam Uitleg
trainingId verplicht Van welke training je de lessen wilt.
limit Aantal items per pagina, 1 tot en met 500. Standaard 100. Een waarde daarbuiten geeft een fout in plaats van een stille correctie.
cursor De nextCursor uit het vorige antwoord. Blijf doorbladeren tot nextCursor null is, ook als een pagina niet vol zit.

Voorbeeld

curl "https://scintillating-wolf-799.eu-west-1.convex.site/v1/lessons?trainingId=…" \
  -H "Authorization: Bearer <je sleutel>"

Antwoord

{
  "items": [
    {
      "id": "pl4…",
      "trainingId": "ps7…",
      "moduleId": "pm2…",
      "name": "Je camera instellen",
      "slug": "je-camera-instellen",
      "type": "lesson",
      "displayOrder": 1,
      "hasVideo": true,
      "contentDripType": "immediate",
      "createdAt": 1759276800000
    }
  ],
  "nextCursor": null
}

Velden

Veld Type Betekenis
id string Vaste verwijzing naar deze les.
trainingId string De training waar de les bij hoort.
moduleId string of null De module waarin de les staat. Null bij een les zonder module.
name string Naam van de les.
slug string of null Adresdeel bij de klant.
type string lesson of quiz.
displayOrder getal Volgorde binnen de training.
hasVideo boolean Of er video aan hangt. De video zelf komt niet mee.
contentDripType string of null Of de les pas later beschikbaar komt, en waarop dat wacht.
createdAt getal Aanmaakmoment.

Veelgestelde vragen

Waarom krijg ik een 404 op een trainingId dat bestaat?
Dan hoort die training bij een andere omgeving. Het antwoord is met opzet hetzelfde als bij een training die niet bestaat, zodat je niet kunt afleiden welke ids elders in gebruik zijn.
Wat is het verschil tussen type lesson en quiz?
Een quiz stelt vragen die het lid moet beantwoorden. De vragen zelf komen niet mee in de API.

Hierna nodig

Werkt je aanroep niet zoals verwacht, kijk dan bij de foutcodes en wat ze betekenen. Heb je nog geen sleutel, dan legt de kennisbank uit hoe je er een aanmaakt.