DokumentationProdukteArtim Academy LMSSchülerSchüler V1
Konto einschreiben
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Schreibt ein Konto der Akademie in einen Kurs ein.
Das Konto muss Mitglied dieser Akademie sein — eine Einschreibung legt kein Konto an. Hat der Kurs einen Standard-Lernpfad, bekommt die Einschreibung ihn; learningPathId überschreibt das. Eine zweite Einschreibung derselben Paarung ist eine 409.
POST https://students.api.lms.artim-industries.com/v1/enrollments
| Methode | POST |
| Basis | students.api.lms.artim-industries.com/v1 |
| Scope | lms.students.enrollments:write |
| Antwort | 201 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer lmsapi_… |
Parameter
Dieser Endpunkt nimmt keine Parameter.
Anfragekörper
| Feld | Typ | Bedeutung |
|---|---|---|
userId | string | Das Konto. Pflicht. |
courseId | string | Der Kurs. Pflicht. |
learningPathId | string | Ein anderer Lernpfad als der Standard. |
Felder, die der Vertrag nicht nennt, werden verworfen — ein Client kann keine eigenen Felder unterschieben.
{ "userId": "usr_5a2c", "courseId": "crs_1a9f" }
Anfrage
curl -X POST "https://students.api.lms.artim-industries.com/v1/enrollments" \
-H "Authorization: Bearer lmsapi_…" \
-H "Content-Type: application/json" \
-d '{ "userId": "usr_5a2c", "courseId": "crs_1a9f" }'
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
id | string | Die Kennung der neuen Einschreibung. |
status | string | active. |
learningPathId | string | Der zugewiesene Lernpfad. |
{ "id": "enr_3b90", "status": "active", "learningPathId": "lp_88a2" }
Fehler
| Status | code | Wann |
|---|---|---|
400 | invalid_request | Ein Pflichtfeld fehlt, ein Typ passt nicht, oder ein Verweis zeigt auf etwas, das es hier nicht gibt. |
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. |
403 | missing_scope | Das Token trägt den Scope dieses Endpunkts nicht. |
404 | not_found | Der Eintrag gehört nicht zum freigegebenen Akademie — oder die Anfrage kam auf der falschen Subdomain an. |
409 | conflict | Der Zustand verbietet die Änderung — der Fehlerkörper nennt den Grund. |
429 | rate_limited | Kontingent erschöpft, siehe Retry-After. |
Jede Fehlerantwort trägt dieselbe Hülle: error.code benennt den Fehler, error.message sagt in einem Satz, was fehlt.
Rate Limits
Das Limit gilt pro Team, nicht pro Token.
| Zugang | Produktion | Sandbox |
|---|---|---|
| Hobby | 60 Anfragen/Minute | ohne Limit |
| Developer Mitgliedschaft | 10.000 Anfragen/Minute | ohne Limit |
Bei 429 sagt der Retry-After-Header, wie lange du warten sollst.