# Read learning route

Read the IELTS full-course learning route as factual data, grouped by subject and unit, with course-level progress. Use view=progress for a compact summary. The Tool does not choose or recommend the next course.

- Capability ID: `learning_route.read`
- Operation: `ielts_learning_route_read`
- Category: 课程学习
- Endpoint: `POST /api/v1/agent/capabilities/ielts_learning_route_read`
- Authentication: Bearer Token（通过 /api/v1/agent-bindings 绑定账号）
- Required scopes: courses:read
- Side effect: read
- Human documentation: https://ieltsbuddy.igopx.cn/developers/api/ielts_learning_route_read

## Request parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | number | 否 | Maximum route course nodes to return. |
| `subject` | string | 否 | Optional IELTS subject filter. Empty returns the full-course route. |
| `view` | string | 否 | Full ordered route nodes, or a compact progress-only view. |

## Request example

```bash
curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_learning_route_read' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $IELTS_BUDDY_TOKEN' \
  --data '{"limit":200,"subject":"","view":"route"}'
```

## Request schema

```json
{
  "type": "object",
  "properties": {
    "limit": {
      "default": 200,
      "description": "Maximum route course nodes to return.",
      "type": "integer",
      "minimum": 1,
      "maximum": 500
    },
    "subject": {
      "default": "",
      "description": "Optional IELTS subject filter. Empty returns the full-course route.",
      "type": "string",
      "enum": [
        "",
        "listening",
        "reading",
        "writing",
        "speaking"
      ]
    },
    "view": {
      "default": "route",
      "description": "Full ordered route nodes, or a compact progress-only view.",
      "type": "string",
      "enum": [
        "route",
        "progress"
      ]
    }
  },
  "required": [
    "limit",
    "subject",
    "view"
  ],
  "additionalProperties": false
}
```

## Response envelope

```json
{
  "code": 0,
  "data": {},
  "message": "ok"
}
```

## Errors

| HTTP | Code | Meaning |
| --- | --- | --- |
| 400 | `40001` | 请求参数不符合接口契约 |
| 401 | `40101` | 缺少或使用了无效的访问令牌 |
| 403 | `40301` | 访问令牌不包含接口所需权限 |
| 404 | `40401` | 接口或目标资源不存在 |