新增組織

更新時間：2023-04-04 09:31:23

介面描述

1、组织架构新增子节点（排在第一位）
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/organization/create

線上API呼叫

請求方式

POST

介面限制

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

2、組織層級限制不超過5級

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】

請求體參數描述

參數名	必選	類型	說明
parentId	true	Integer	父節點組織ID【可透過查詢組織架構列表取得】
name	true	String	組織架構名稱，最大長度12個字元
description	false	String	組織描述，最大長度100個字元

範例

http://api.polyv.net/live/v4/user/organization/create?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

請求體json參數：

{
    "parentId": "2730",
    "name": "测试部门",
    "description":"负责以解决客户业务测试问题为目的的测试解决方案架构和研发工作"
}

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Object	組織架構資訊【詳見data欄位說明】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛上鉤

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

data參數描述

參數名	類型	說明
userId	String	用戶ID
id	Integer	組織ID
name	String	組織名稱
description	String	組織描述
icon	String	圖示
lft	Integer	左節點
rgt	Integer	右節點
parentId	Integer	父級組織的左節點ID

Java請求範例

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

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新增组织
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createOrganizationTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/organization/create";
    String parentId = "2730";
    String name = "测试部门";
    String description = "负责以解决客户业务测试问题为目的的测试解决方案架构和研发工作";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("parentId", parentId);
    jsonMap.put("name", name);
    jsonMap.put("description", description);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新增组织成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data": {
        "userId": "1b448be323",
        "id": 2757,
        "lft": 3,
        "rgt": 4,
        "parentId": 2,
        "name": "测试部门",
        "icon": null,
        "description": "负责以解决客户业务测试问题为目的的测试解决方案架构和研发工作"
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}