Dictionary - dinhhuy2808/q-chinese-doc GitHub Wiki

delete

  • GET /dictionary/v2/delete/{tab} {tab}: tab name
  • response: true, false.

Get word audio stream

  • GET /dictionary/read/{hantu}
  • response: stream buffer of audio.

add word to tab.

  • POST /dictionary/v2/addWordsToUserDictionaryFromDictionary/{tab}/{where}

get Course Dictionary

  • POST /dictionary/getCourseDic
  • body:
{
   "hsk":1,
   "lesson": "1",
   "part":"1"
}
  • response:
[
	{
		"id": 6884,
		"hantu": "生病",
		"pinyin": "shēngbìng",
		"nghia1": "sinh bệnh, bị ốm",
		"hsk": 2,
		"lesson": "2",
		"part": "1"
	},
	...
]

translate By Word

  • GET /dictionary/v2/translate/{word}
  • response:
{
	"id": 9871,
	"hantu": "æ—©",
	"pinyin": "zÇŽo",
	"nghia1": "sá»›m",
	"hanviet": "",
	"hsk": 0,
	"standart": 0,
	"popular": 0
}

getUserTabs

  • POST /dictionary/v2/getUserTabs

  • response:

{"values":["Từ vựng tiêu chuẩn","Từ vựng thông dụng","test"]}

add To User Dictionary

  • POST /dictionary/v2/addToUserDictionary/{id}/{tab}/{where} {id}:word id {tab}:add to target tab {where}: place of word to add

  • response: true, false.

deleteUserDictionary

  • POST /dictionary/v2/user-dictionary/delete
  • body:
{
   "wordIds":"1,2,3,4",
   "tab":"tab name"
}

Get User Dictionary

  • POST /dictionary/v2/getUserDictionary/{tab}
  • body:
{
   datatableParam: dataTablesParameters,
   userDictionarySearchParam: userDictionarySearchParam,
}

class ben angular la any, nay la ben java
class DatatableParam {
	private int draw;
	private List<Column> columns;
	private List<Order> order;
	private int start;
	private int length;
	private Search search;
}

class UserDictionarySearchParam {
    createDate: string[];
    hsk: number[];
    lesson: string[];
    hantu: string;
    nghia: string;
}

example body: 
{
"datatableParam":{
   "draw":1,
   "columns":[
      {
         "data":0,
         "name":"",
         "searchable":true,
         "orderable":false,
         "search":{
            "value":"",
            "regex":false
         }
      },
      {
         "data":1,
         "name":"",
         "searchable":true,
         "orderable":false,
         "search":{
            "value":"",
            "regex":false
         }
      },
      {
         "data":2,
         "name":"",
         "searchable":true,
         "orderable":false,
         "search":{
            "value":"",
            "regex":false
         }
      },
      {
         "data":3,
         "name":"",
         "searchable":true,
         "orderable":false,
         "search":{
            "value":"",
            "regex":false
         }
      },
      {
         "data":4,
         "name":"",
         "searchable":true,
         "orderable":false,
         "search":{
            "value":"",
            "regex":false
         }
      },
      {
         "data":5,
         "name":"",
         "searchable":true,
         "orderable":false,
         "search":{
            "value":"",
            "regex":false
         }
      },
      {
         "data":6,
         "name":"",
         "searchable":true,
         "orderable":false,
         "search":{
            "value":"",
            "regex":false
         }
      }
   ],
   "order":[
      
   ],
   "start":0,
   "length":20,
   "search":{
      "value":"",
      "regex":false
   }
},
"userDictionarySearchParam":{
   "createDate":[
      
   ],
   "hsk":[
      
   ],
   "lesson":[
      
   ],
   "hantu":"",
   "nghia":""
}
}
  • response:
{
    "draw": 1,
    "rescordsTotal": 12312,
    "recordsFiltered": 12312,
    "data": [
        {
            "wordId": 1,
            "hantu": "你",
            "pinyin": "nǐ",
            "nghia1": "bạn, anh, chị..",
            "hsk": 1,
            "lesson": "1",
            "part": "1",
            "standart": 1,
            "popular": 0,
            "tab": "Từ vựng tiêu chuẩn",
            "place": "",
            "isChecked": false,
            "input": "",
            "correctLevel": 0,
            "isHantuHidden": false,
            "isPinyinHidden": false,
            "isNghiaHidden": false,
            "isAudioHidden": false
        },
        {
            "wordId": 2,
            "hantu": "好",
            "pinyin": "hǎo",
            "nghia1": "khỏe, tốt",
            "hsk": 1,
            "lesson": "1",
            "part": "1",
            "standart": 1,
            "popular": 0,
            "tab": "Từ vựng tiêu chuẩn",
            "place": "",
            "isChecked": false,
            "input": "",
            "correctLevel": 0,
            "isHantuHidden": false,
            "isPinyinHidden": false,
            "isNghiaHidden": false,
            "isAudioHidden": false
        },
...
}

addWordsToUserDictionary

  • POST /dictionary/v2/addWordsToUserDictionary/{tab}/{where}
  • body:
[id1, id2,...]
  • tab: Từ vựng đã lưu
  • where:
    • In Course screen: hsk-{hsk}-lesson-{lesson}-part-{part}
    • In Quiz or Test screen: hsk-{hsk}-lesson-{lesson}
  • Response: true, false

addWordsToUserDictionaryFromDictionary

  • use this API to save Word in Tuvung Module
  • POST /dictionary/v2/addWordsToUserDictionaryFromDictionary/{tab}/{where}
  • example: /dictionary/v2/addWordsToUserDictionaryFromDictionary/Từ vựng đã lưu/Từ vựng tiêu chuẩn
  • tab: destination, where: from
  • body:
{
  [
   {
      "wordId":1,
      "hantu":"你",
      "pinyin":"nǐ",
      "nghia1":"bạn, anh, chị..",
      "hsk":1,
      "lesson":"1",
      "part":"1",
      "standart":1,
      "popular":0,
      "tab":"Từ vựng tiêu chuẩn",
      "place":"",
      "isChecked":true,
      "input":"",
      "correctLevel":0,
      "isHantuHidden":false,
      "isPinyinHidden":false,
      "isNghiaHidden":false,
      "isAudioHidden":false
   },
   {
      "wordId":8,
      "hantu":"不",
      "pinyin":"bù",
      "nghia1":"không",
      "hsk":1,
      "lesson":"2",
      "part":"1",
      "standart":1,
      "popular":0,
      "tab":"Từ vựng tiêu chuẩn",
      "place":"",
      "isChecked":true,
      "input":"",
      "correctLevel":0,
      "isHantuHidden":false,
      "isPinyinHidden":false,
      "isNghiaHidden":false,
      "isAudioHidden":false
   }
 ]
}
  • Response: true, false

getUserUserDictionaryCreateDate

  • return creation dates for word
  • Will always return nothing for table "Từ vựng tiêu chuẩn" & "Từ vựng thông dụng"
  • POST /dictionary/v2/getUserUserDictionaryCreateDate/{tab}
  • example /dictionary/v2/getUserUserDictionaryCreateDateTừ vựng đã lưu
  • Response:
{
    "values": [
        "20210125"
    ]
}

QChinese API

API Url: 103.92.29.71:8080

Note: Những API có chứa v2 yêu cầu phải có jwt token trong Authorization Request Header.

⚠️ **GitHub.com Fallback** ⚠️