...
- 版本
- 请求简述
- 参数说明
- 服务地址
- 错误调试
- HTTP方法
- 认证
- 分页
- 指定用户代理
- 次数限制
版本说明
默认情况下当客户端访问https://cn.vnnox.com时,系统将使用V1 版REST API提供服务,我们建议您在http请求的heaer中的`Accept`字段加上服务版本号。格式如下:
...
注:为了不影响第三方功能对接,当前v1版本的REST API接口及接口中的数据会以增量方式更新。
请求简述
所有请求均通过HTTPS协议,API请求链接为https://cn.vnnox.com,所有数据的请求及相应均通过json格式。
数据结构
| Code Block | ||
|---|---|---|
| ||
{
"http_code": 200, //http状态码
"data": {...some data...}, //数据部分
"status": [10000001] //业务相关状态码
} |
请求列表
通过GET请求获取资源信息时,如果未指定资源唯一ID,则请求的为资源的列表,返回的数据list中包含了符合查询规则的集合list
| Code Block | ||
|---|---|---|
| ||
{
"http_code": 200,
"data": {
"userList": [
{
"uid": "2",
"oid": "6",
"wid": "311",
"enable": "1",
"org_reg": "0",
"uName": "user1",
"user_conf": {...},
"user_statistic": {... },
"workgroup": {... },
"role": [...]
},
{
"uid": "20",
"oid": "6",
"wid": "3113",
"enable": "1",
"org_reg": "0",
"uName": "user2",
"user_conf": {...},
"user_statistic": {...},
"workgroup": {... },
"role": [... ]
},
{
"uid": "10",
"oid": "6",
"wid": "3112",
"enable": "1",
"org_reg": "0",
"uName": "user3",
"user_conf": {...},
"user_statistic": {...},
"workgroup": {...},
"role": [...]
}
],
"count": "3"
},
"status": [
10000001
]
} |
请求详情
如果在资源请求中指定唯一ID,则请求的为单个资源,返回的数据只包含当前资源
| Code Block | ||
|---|---|---|
| ||
{
"http_code": 200,
"data": {
"uid": "2567",
"oid": "67",
"wid": "3114",
"enable": "1",
"org_reg": "0",
"uName": "lileilei_3",
"user_conf": {
"uid": "2567",
"default_approve": "1",
"isAdmin": "0",
"firstName": "li",
"familyName": "lei",
"mail": "vnnox_team@126.com",
"phoneCountryCode": "0086",
"phoneNumber": "13282829999",
"userLang": "1"
...},
"role": [
{
"rid": "479",
"uid": "2567",
"name": "清单制作员"
},
{
"rid": "480",
"uid": "2567",
"name": "排期制作员"
}
...],
"workgroup": [
{
"wid": "245",
"oid": "67",
"is_system": "1",
"parentID": "0",
"workGroupName": "系统工作组",
"remark": "",
"checked": false,
"implicitResources": []
}
{
"wid": "2334",
"oid": "67",
"is_system": "0",
"parentID": "0",
"workGroupName": "workgroup1",
"remark": "",
"user": [],
"checked": false,
"implicitResources": []
}
...],
"systemMediaApprove": "0"
},
"status": [
10405001
]
} |