DokumentationProdukteArtim Academy LMSSchülerSchüler V1
Einschreibung ändern
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Setzt Stand oder Lernpfad einer Einschreibung.
PUT https://students.api.lms.artim-industries.com/v1/enrollments/{id}
| Methode | PUT |
| Basis | students.api.lms.artim-industries.com/v1 |
| Scope | lms.students.enrollments:update |
| Antwort | 200 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer lmsapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Die Kennung der Einschreibung. |
Anfragekörper
| Feld | Typ | Bedeutung |
|---|---|---|
status | string | active, completed oder paused. |
learningPathId | string | Ein anderer Lernpfad desselben Kurses. |
Felder, die der Vertrag nicht nennt, werden verworfen — ein Client kann keine eigenen Felder unterschieben.
{ "status": "paused" }
Anfrage
curl -X PUT "https://students.api.lms.artim-industries.com/v1/enrollments/{id}" \
-H "Authorization: Bearer lmsapi_…" \
-H "Content-Type: application/json" \
-d '{ "status": "paused" }'
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
id | string | Die Kennung. |
status | string | Der Stand danach. |
{ "id": "enr_3b90", "status": "paused" }
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.