学词单元详细信息V3.0.0 - 桃李中文-Taoli-Cloud

请求参数

Header 参数

payload

string

可选

默认值:

{'mid':{{mid}},'username':{{username}}}

Authorization

string

可选

默认值:

bearer {{access_token}}

Body 参数application/json

id

integer <int64>

课程ID

可选

levelId

integer <int64>

关卡ID

必需

version

string

版本号

可选

示例

{
    "id": 0,
    "levelId": 0,
    "version": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://test-apisix.taolihanyu.net/roadmap/app-api/v1/chapter/detail' \
--header 'payload: {'\''mid'\'':{{mid}},'\''username'\'':{{username}}}' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 0,
    "levelId": 0,
    "version": "string"
}'

返回响应

🟢200成功

application/json

Body

code

string

可选

data

object (ChapterDetailVO)

可选

id

integer <int64>

章节ID

可选

levelId

integer <int64>

关卡ID

可选

levelName

string

关卡名称

可选

gradeId

integer <int64>

等级ID

可选

grade

string

等级

可选

sort

integer

排序

可选

free

enum<string>

可选

是否免费 0 no, 1 yes

枚举值:

NOYESNE

backImg

string

背景图片

可选

coverImg

string

可选

封面图片-默认取视频图片

words

string

词库词ID

可选

video

integer <int64>

可选

视频ID/新版导入视频

examples

string

可选

例句: 词库释义ID

duration

string

视频时长

可选

status

enum<string>

可选

1 可用, 0 不可用

枚举值:

FAILEDBLOCKENABLESHELVESUNBLOCKDISABLE

title

string

单元标题

可选

tips

string

简介

可选

wordInfos

array[object (WordInfoVO) {17}]

单词详情

可选

默认值:

Lists.newArrayList()

expressions

array[object (ExpressionDTO) {5}]

例句

可选

默认值:

Lists.newArrayList()

consumption

string

估计耗时

可选

collectEd

integer

可选

是否收藏 0-未收藏 1-已收藏

默认值:

0

schedule

integer

v2 进度

可选

quantity

integer

v2 总数

可选

complete

integer

v2 学习完成人数

可选

avatars

array[string]

v2 头像

可选

reportId

integer <int64>

v2 学习报告ID

可选

studyStatus

integer

可选

v2 学习状态 0 未学，1继续，2无报告，3学完

默认值:

0

virtualQuantity

integer

虚拟数量

可选

realQuantity

integer

真实数量

可选

isBuy

enum<string>

是否桃李币购买

可选

枚举值:

NOYESNE

默认值:

{code: 0, desc: 否}

msg

string

可选

total

integer

可选

示例

{
  "code": "",
  "data": {
    "id": 0,
    "levelId": 0,
    "levelName": "",
    "gradeId": 0,
    "grade": "",
    "sort": 0,
    "free": "",
    "backImg": "",
    "coverImg": "",
    "words": "",
    "video": 0,
    "examples": "",
    "duration": "",
    "status": "",
    "title": "",
    "tips": "",
    "wordInfos": [
      {
        "id": 0,
        "type": "",
        "word": "",
        "pinyin": "",
        "explanationEn": "",
        "soundUrl": "",
        "imgUrl": "",
        "study": "",
        "collect": "",
        "video": 0,
        "videoUri": "",
        "expression": {
          "sentence": "",
          "translate": "",
          "soundType": 0,
          "realSoundUrl": "",
          "wordExplain": [
            {
              "word": "",
              "pinyin": "",
              "position": 0
            }
          ]
        },
        "expressions": [
          {
            "sentence": "",
            "translate": "",
            "soundType": 0,
            "realSoundUrl": "",
            "wordExplain": [
              {
                "word": "",
                "pinyin": "",
                "position": 0
              }
            ]
          }
        ],
        "splitWord": [
          {
            "type": "",
            "word": "",
            "spell": "",
            "audio": "",
            "sort": 0,
            "splices": [
              ""
            ]
          }
        ],
        "splices": [
          ""
        ],
        "sliceWord": [
          {
            "word": "",
            "pinyin": "",
            "strokeUri": ""
          }
        ],
        "assemble": [
          {
            "": [
              ""
            ]
          }
        ]
      }
    ],
    "expressions": [
      {
        "sentence": "",
        "translate": "",
        "soundType": 0,
        "realSoundUrl": "",
        "wordExplain": [
          {
            "word": "",
            "pinyin": "",
            "position": 0
          }
        ]
      }
    ],
    "consumption": "",
    "collectEd": 0,
    "schedule": 0,
    "quantity": 0,
    "complete": 0,
    "avatars": [
      ""
    ],
    "reportId": 0,
    "studyStatus": 0,
    "virtualQuantity": 0,
    "realQuantity": 0,
    "isBuy": ""
  },
  "msg": "",
  "total": 0
}