开始白板标注
REST URL格式 |
访问方法 |
URI |
|||
POST |
https://ip/v1/whiteboard/annotation/start |
||||
接口功能 |
开始白板标注 |
||||
接口说明 |
本接口调用后,可模拟开启白板标注 |
||||
响应数据 |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
success |
int |
[0, 1] |
响应结果 0:失败 1:成功 |
data |
Object |
可选, 空对象 |
成功返回数据。这里返回空。 例如:{"success":1,"data":"{\"szCommStr\":\"xx.xxxxxx\"}"} |
error |
Object |
可选 |
失败返回错误信息,参见表3 例如:{"success":0,"error":{"id":100666744,"code":134250502,"params":[]}} |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
id |
int |
32位整数 |
错误id,用于转换。 |
code |
int |
32位整数 |
错误码,跟错误id对应,具体含义参考错误码。 |
param |
Object |
param 对象 |
失败响应的附带参数。 1. 标志已开始,不能再次标注: Annotation is started, can not start again 2. 当前页面不可标注:Current page cannot Annotation |