Răsfoiți Sursa

docs: 更新接口文档

weijianghai 2 ani în urmă
părinte
comite
d5c12c2257

+ 35 - 1
doc/开发测试文档/开发环境建设/开发环境建设.md

@@ -62,7 +62,10 @@ CREATE TABLE sqmdb_rpt.acl_function (
 	"name" varchar NOT NULL, -- 功能名称
 	url varchar NOT NULL, -- 功能链接
 	client int4 NOT NULL, -- 展示的客户端
-	"system" varchar NOT NULL,
+	"system" varchar NOT NULL, -- 系统模块
+	icon varchar NOT NULL DEFAULT ''::character varying, -- 图标链接
+	app_icon varchar NOT NULL DEFAULT ''::character varying, -- app图标链接
+	priority int4 NOT NULL DEFAULT 0, -- 显示优先级,值越大越靠前
 	CONSTRAINT acl_app_function_pk PRIMARY KEY (id)
 );
 COMMENT ON TABLE sqmdb_rpt.acl_function IS '功能';
@@ -73,6 +76,10 @@ COMMENT ON COLUMN sqmdb_rpt.acl_function.id IS '主键';
 COMMENT ON COLUMN sqmdb_rpt.acl_function."name" IS '功能名称';
 COMMENT ON COLUMN sqmdb_rpt.acl_function.url IS '功能链接';
 COMMENT ON COLUMN sqmdb_rpt.acl_function.client IS '展示的客户端';
+COMMENT ON COLUMN sqmdb_rpt.acl_function."system" IS '系统模块';
+COMMENT ON COLUMN sqmdb_rpt.acl_function.icon IS '图标链接';
+COMMENT ON COLUMN sqmdb_rpt.acl_function.app_icon IS 'app图标链接';
+COMMENT ON COLUMN sqmdb_rpt.acl_function.priority IS '显示优先级,值越大越靠前';
 -- sqmdb_rpt.acl_user_function definition
 
 -- Drop table
@@ -119,3 +126,30 @@ COMMENT ON COLUMN sqmdb_rpt.acl_verification_log.city_id IS '所属地市';
 COMMENT ON COLUMN sqmdb_rpt.acl_verification_log."system" IS '登入模块';
 COMMENT ON COLUMN sqmdb_rpt.acl_verification_log.login_time IS '登录时间';
 ```
+
+测试数据
+```sql
+INSERT INTO sqmdb_rpt.acl_function (id,"name",url,client,"system",icon,app_icon,priority) VALUES
+	 (1,'工单处理','/pages/index/index?type=dispose',1,'flow','','icon1',88),
+	 (2,'工单查询','/pages/index/index?type=query',0,'flow','','icon2',77),
+	 (3,'工单答复','/pages/index/index?type=reply',1,'flow','','icon3',99),
+	 (4,'黑点库查询','',-1,'heidianku','','',0),
+	 (5,'黑点库管理','',-1,'heidianku','','',0),
+	 (6,'投诉大屏','',-1,'daping','','',0),
+	 (7,'投诉分析','',-1,'fenxi','','',0),
+	 (8,'投诉预测','',-1,'yuce','','',0);
+
+select * from acl_user_role_city aurc
+inner join acl_role ar on aurc.role_id = ar.role_id
+inner join acl_user au on au.user_id = aurc.user_id
+where aurc.user_id = 555;
+
+select distinct aurc.user_id
+from acl_user_role_city aurc
+inner join acl_role ar on aurc.role_id = ar.role_id
+inner join acl_user au on au.user_id = aurc.user_id
+where ar.role_name like '工单处理%'
+order by aurc.user_id;
+
+select * from acl_function order by id;
+```

+ 10 - 2
doc/开发测试文档/接口开发/acl提供给app的接口.md

@@ -22,12 +22,16 @@ Content-Type: application/json
     {
       "id": 1,
       "name": "工单处理",
-      "url": "url"
+      "url": "url",
+      "appIcon": "appIcon",
+      "priority": 0
     },
     {
       "id": 2,
       "name": "工单答复",
-      "url": "url"
+      "url": "url",
+      "appIcon": "appIcon",
+      "priority": 0
     }
   ]
 }
@@ -41,6 +45,10 @@ name: 功能名称
 
 url: 功能链接
 
+appIcon: app图标链接
+
+priority: 显示优先级,值越大越靠前
+
 ### 特殊情况
 
 - 无任何权限

+ 2 - 2
doc/开发测试文档/接口开发/acl提供给投诉大屏的接口.md

@@ -5,8 +5,8 @@
 
 ## 鉴权接口
 
-token  测试token test_token_*** 正式token来自入口url
-fromSystem 测试token为test 正式token是dop
+token  测试token test_token_*** 正式token来自入口url,沃运维是globalUniqueID
+fromSystem 测试为test,正式是dop或woyunwei
 system 是固定值 daping
 
 ### system 由调用接口的系统确定

+ 61 - 0
doc/开发测试文档/接口开发/acl提供给流程的接口.md

@@ -394,3 +394,64 @@ Content-Type: application/json
   "user": []
 }
 ```
+
+## 全部用户信息列表接口
+
+```http
+POST HTTP://127.0.0.1:12128/rest/api/user/baselist
+Content-Type: application/json
+
+{}
+```
+
+```json
+{
+  "success": true,
+  "code": 1,
+  "message": "成功",
+  "data": [
+    {
+      "userId": 501,
+      "loginName": "he-licg",
+      "userName": "李春光",
+      "phone": "18631406013",
+      "email": "",
+      "org": "承德市分公司5G共建共享工作组移网网络优化网格",
+      "provinceId": -1,
+      "cityId": 130800,
+      "areaId": null
+    },
+    {
+      "userId": 502,
+      "loginName": "yanghw15",
+      "userName": "杨宏伟",
+      "phone": "18603140990",
+      "email": "",
+      "org": "承德市分公司云网运营交付中心接入侧综合维护网格",
+      "provinceId": -1,
+      "cityId": 130800,
+      "areaId": 130802
+    }
+  ]
+}
+```
+
+### 输出参数说明
+
+userId: 用户id
+
+loginName: 登录账号
+
+userName: 用户名
+
+phone: 手机号
+
+email: 邮箱
+
+org: 组织
+
+provinceId: 省份id
+
+cityId: 地市id
+
+areaId: 区县id

+ 84 - 0
doc/开发测试文档/接口测试/口碑对接沃运维测试.md

@@ -0,0 +1,84 @@
+# 口碑对接沃运维测试
+
+获取用户信息接口:应用系统通过获取到的globalUniqueID的值获取用户信息。
+
+- 正常返回
+
+```http
+POST HTTPS://10.170.43.39:8038/PAOOS/aaaa/userservice/getUserInfo.do?method=findUserBySessionID&sessionID=5BBACBD6303147FDB643C871AFE57ED6
+Content-Type: application/json
+```
+
+```json
+{
+  "address": "null",
+  "admin": false,
+  "attribute1": "5BBACBD6303147FDB643C871AFE57ED6",
+  "attribute2": "1667804964061",
+  "attribute5": "update",
+  "category": "PRO",
+  "commonPwdUse": true,
+  "createDate": "2016-10-09 17:41:57",
+  "createPerson": "root-hsh",
+  "createType": 1,
+  "deleteFlag": false,
+  "email": "wangyl5740@chinaunicom.cn",
+  "fax": "",
+  "job": "",
+  "jobNum": "0875628",
+  "lastUpdateDate": "2022-10-17 20:50:49",
+  "lastUpdatePerson": "root",
+  "mobilePhone": "18631112100",
+  "orgCode": "2180002",
+  "orgEntity": {
+    "allowExtended": true,
+    "allowModify": true,
+    "areaCode": "1300039",
+    "areaId": 39,
+    "createDate": "2016-01-01 03:48:11",
+    "createPerson": "root",
+    "createType": 1,
+    "deleteFlag": false,
+    "fullOrgName": "河北省分公司-本部-网络分公司优化中心",
+    "lastUpdateDate": "2016-08-19 16:20:47",
+    "lastUpdatePerson": "root-heb",
+    "leaf": true,
+    "orgCode": "2180002",
+    "orgId": 10248,
+    "orgLevel": 3,
+    "orgName": "网络分公司优化中心",
+    "orgType": "DEP",
+    "parentOrgCode": "21800",
+    "parentOrgId": 10234,
+    "proCode": "218",
+    "sortNum": 99,
+    "ucloudName": "网络公司河北省分公司网络优化中心",
+    "ucloudOrgCode": "00130090268",
+    "ucloudParentName": "河北省分公司管理部门",
+    "ucloudParentOrgCode": "001300"
+  },
+  "orgID": 10248,
+  "passWord": "e9ae76bc363600a3bc947e7b84b29acd",
+  "personType": 0,
+  "professional": "",
+  "pwdDeadDate": 1673959849239,
+  "pwdUpdateDate": 1540950800000,
+  "remark": "",
+  "sex": 0,
+  "telephone": "",
+  "trueName": "王玉龙",
+  "userId": 576532,
+  "userName": "wangyl5740"
+}
+```
+
+- 错误的或不存在的globalUniqueID
+
+```http
+POST HTTPS://10.170.43.39:8038/PAOOS/aaaa/userservice/getUserInfo.do?method=findUserBySessionID&sessionID=5BBACBD6303147FDB643C871AFE577777
+Content-Type: application/json
+```
+
+```json
+null
+```