DokumentationProdukteArtim Academy LMSSchülerSchüler V1
Schüler abrufen
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Ein Konto samt seiner Kurse in dieser Akademie.
GET https://students.api.lms.artim-industries.com/v1/students/{id}
| Methode | GET |
| Basis | students.api.lms.artim-industries.com/v1 |
| Scope | lms.students:read |
| Antwort | 200 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer lmsapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Die Kennung aus der Schülerliste. |
Anfrage
curl "https://students.api.lms.artim-industries.com/v1/students/{id}" \
-H "Authorization: Bearer lmsapi_…"
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
id | string | Die Kennung. |
email | string | Die Adresse. |
firstName | string | Der Vorname. |
lastName | string | Der Nachname. |
avatarUrl | string | Das Profilbild. |
roles | array | Die Rollen in dieser Akademie. |
courses | array | Die Kurse als {courseId, status, percent}. |
{
"id": "usr_5a2c",
"email": "[email protected]",
"firstName": "Mia",
"lastName": "Feld",
"avatarUrl": null,
"roles": ["student"],
"courses": [{ "courseId": "crs_1a9f", "status": "active", "percent": 42.5 }]
}
Fehler
| Status | code | Wann |
|---|---|---|
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. Verlängern über https://api.artim-industries.com/v1/oauth/token. |
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. |
422 | invalid_request | Ein Parameter hat den falschen Typ oder liegt außerhalb des erlaubten Bereichs. |
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.