刪除課節

更新時間：2024-10-21 09:33:43

介面描述

1、删除课节
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/hi-class-api/open/lesson/v1/delete

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值【詳見簽名產生規則】

請求體參數描述

參數名	必選	類型	說明
lessonId	true	Long	課節號

範例

http://api.polyv.net/hi-class-api/open/lesson/v1/delete?appId=frlr1zazn3&sign=179E93416D4144C920428C0325436FF2&timestamp=1634629905501

請求體參數

{
    "lessonId": "8970"
}

響應參數描述

參數名	類型	說明
code	Integer	響應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	響應狀態文字資訊
error	Error	錯誤物件【詳見全域錯誤說明】
data	Object	請求失敗時為空，請求成功時刪除狀態資訊【詳見data欄位描述】

data欄位描述

參數名	類型	說明
status	Boolean	true:成功; false:失敗

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

private static final Logger log = LoggerFactory.getLogger(VClassLessonTest.class);
/**
 * 删除课节
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void deleteLesson() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/hi-class-api/open/lesson/v1/delete";
    String lessonId = "8970";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("lessonId", lessonId);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    log.info("测试删除课节成功：{}", response);
}

響應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "5bc5c3a4a88a487192cb0256b1dadb7f.97.16346299090189905",
    "data": {
        "status": false
    },
    "success": true
}

異常範例

{
  "code": 400,
  "status": "error",
  "data": "",
  "error": {
    "code": xx,
    "desc": "错误描述"
  }
}