REST API
GET/ api/ v1/ progress
Пройденные уроки, позиции проигрывателя в секундах, домашние задания и отметки плана.
| Поле | Значение |
|---|---|
| URL | GET |
| Доступ | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth |
| Scope для ключей | course: |
| operationId | progressGet |
Описание#
Пройденные уроки, позиции проигрывателя в секундах, домашние задания и отметки плана.
Auth: сессия кабинета (cookie) / TMA bearer / API-ключ или OAuth access token. Scope: course: (для ключей).
Path: параметров нет.
Query: нет объявленных полей.
Body: не требуется.
Ответ · статус и структура
Ответ: 200 application/, Progress.
Краткая форма: {.
Пример JSON; значения демонстрационные.
{
"completed": [
"pre.1"
],
"positions": {
"1.1": 310
},
"homework": {
"pre.1": {
"text": "Создал папку проекта и README.",
"sent": true
}
},
"milestonesDone": []
}Ошибки: 401 , 403 , 503 , 429 , 403 , 403 ; общие ошибки.
Лимиты: Agent-key/OAuth: 60/min/key, 2000/UTC day/key, 3000/UTC day/student.
curl -sS -i https://aos.edgelab.space/api/v1/progress \
-H 'Authorization: Bearer aos_live_...'Ответы по контракту#
| Статус | Тип | Схема | Описание |
|---|---|---|---|
| 200 | application/json | Progress | Успех |
| ошибка | application/json | ErrorBody | Ошибка; коды: UNAUTHENTICATED, NO_ENTITLEMENT, ENTITLEMENT_UNAVAILABLE, RATE_LIMITED |
Машиночитаемый контракт: openapi.json, операция progressGet.