Add Organization

Updated: 2023-04-04 09:31:23

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
Organization hierarchy is limited to a maximum of 5 levels.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details in Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See details in Signature Generation Rules

Request Body Parameter Description

Parameter	Required	Type	Description
parentId	true	Integer	Parent node organization ID Can be obtained via Query Organization Structure List
name	true	String	Organization name, maximum 12 characters
description	false	String	Organization description, maximum 100 characters

Example

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

Request body JSON parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic: success returns "success", failure returns "error"
success	Boolean	Response result, determined by business logic: success returns true, failure returns false
data	Object	Organization information See details in data field description
error	Object	Error information when status code is non-200 See details in Error field description
requestId	String	Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, not to be associated with business logic

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
desc	String	Error description, corresponding to error.code

Data Parameter Description

Parameter	Type	Description
userId	String	User ID
id	Integer	Organization ID
name	String	Organization name
description	String	Organization description
icon	String	Icon
lft	Integer	Left node
rgt	Integer	Right node
parentId	Integer	Left node ID of the parent organization

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

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

Live Streaming Server API