URI-A-02 多語標籤 API

Tony Fan

tags: URI-A API規格

取得轉換LABEL的多語翻譯

網址

• path : ${TT-API網址}/labels/{languageId}

Input JSON Path

• path : ${TT-API網址}/labels/{languageId}
• method : GET
• query : 無
• body : 無

{
  "code" <code>,
  "codeList": <codeList>
}

輸入參數說明

買主註冊欄位

欄位名稱	欄位說明	型態	是否必要欄位
languageId	語系代碼	number	Y
code	標籤代碼	String	N
codeList	標籤代碼(多值查詢)	String(Array)	N

• languageId : 參考 URI054 language

Output JSON Path

{
  "code"      : <code> , // 代碼，0：ok、 < 0: error 使用
  "errorMsg"  : <errorMsg>, // 錯誤訊息
  "data" : {
      "label": [
        {
          "code": <code>, //顯示標籤代碼(字串唯一值),
          "name": <name>  //顯示名稱 
        }
      ]
  }
}

輸出參數說明

欄位名稱	欄位說明	型態	是否可為空值
code	代碼	number	N
errorMsg	錯誤訊息	String	Y
data	資訊	多語標籤輸出欄位(Array)	Y

• code : 0：ok、 < 0: error 使用
  • 在此API, 0: ok 代表 啟用成功 / -1 : 啟用失敗

多語標籤輸出欄位

欄位名稱	欄位說明	型態	是否可為空值
label	代碼	標籤欄位(Array)	Y

標籤欄位

欄位名稱	欄位說明	型態	是否可為空值
code	標籤代碼(字串唯一值)	String
name	顯示名稱	String

API 邏輯

參考 URI-A-02 API邏輯 (需有權限才能瀏覽)

範例

參考 URI-A-02 測試案例