From 165ef01356d14cb3378cc3dc89e889f89212ac0c Mon Sep 17 00:00:00 2001
From: houxiao <houxiao@454eff88-639b-444f-9e54-f578c98de674>
Date: 星期三, 08 二月 2017 10:40:16 +0800
Subject: [PATCH] add VisitFace doc
---
VisitFace/document/erdb api.txt | 305 +++++++++++++++++++++++++++
VisitFace/document/2.6 api.json | 321 +++++++++++++++++++++++++++++
VisitFace/document/erdb.vpp | 0
VisitFace/document/2.6.vpp | 0
4 files changed, 626 insertions(+), 0 deletions(-)
diff --git a/VisitFace/document/2.6 api.json b/VisitFace/document/2.6 api.json
new file mode 100644
index 0000000..00cfe48
--- /dev/null
+++ b/VisitFace/document/2.6 api.json
@@ -0,0 +1,321 @@
+1.人脸识别
+{
+ request:
+ {
+ string 学校id
+ img 人脸图片
+ string 地点
+ }
+ response1:
+ {
+ //查询无结果
+ flag 注册标签
+ }
+ response2:
+ {
+ //查询有结果
+ string 学校id
+ int 人员id：
+ string 姓名:
+ string 人员类型：访客；员工
+ string 黑名单状态
+ }
+ 说明:
+}
+
+1.1来访状态判断
+{
+ request:
+ {
+ string :学校id
+ int 访客id
+ }
+ response:
+ {
+ string 来访登记 or 签离
+ }
+ 说明:判断访客状态，同时数据库生成相应记录
+}
+
+1.2签到状态判断
+{
+ request:
+ {
+ string:学校id
+ int:员工id
+ }
+ response:
+ {
+ string 签到 or 签退
+ }
+ 说明:判断签到状态，同时数据库生成相应记录
+}
+
+2.注册保存
+{
+ request:
+ {
+ string 学校id
+ img 图片1 OR 图片2
+ img 证件照
+ string 姓名
+ int 性别
+ string 国籍
+ string 出生日期
+ int 访客分类
+ int 电话
+ int 证件类型
+ string 证件编号
+ string 公司名称
+ string 备注
+ }
+ response:
+ {
+ string 人员id OR 注册状态？
+ }
+}
+
+2.来访登记(访客详情)
+{
+ request:
+ {
+ string 学校id
+ int 人员id
+ }
+ response:
+ {
+ int 人员id
+ string 姓名
+ img 图片
+ string 联系电话
+ string 公司名称
+ string 证件编号
+ }
+ 说明:仅用于信息展示
+}
+
+2.1来访人员
+{
+ request:
+ {
+ string 学校id
+ string 人员类型:访客
+ }
+ response:
+ {
+ int 人员id
+ string 姓名
+ img 图片
+ }
+ 说明：查询学校访客列表
+}
+
+3.被访人员(姓名排序)
+{
+ request:
+ {
+ string 学校id
+ string 人员类型:员工
+ string 排序类型：姓名
+ }
+ response:
+ {
+ int 人员id
+ string 姓名
+ string 部门
+ img 图片
+ }
+ 说明：查询学校员工列表：以姓名排序
+}
+
+3.2被访人员(时间排序)
+{
+ request:
+ {
+ string 学校id
+ string 人员类型:员工
+ string 排序类型：部门
+ }
+ response:
+ {
+ int 人员id
+ string 姓名
+ string 部门
+ img 图片
+ }
+ 说明：查询学校员工列表：以部门排序
+}
+
+3.3员工详情
+{
+ request:
+ {
+ string 学校id
+ int 人员id
+ }
+ response:
+ {
+ int 人员id
+ string 姓名
+ img 图片
+ string 部门
+ string 职务
+ string 手机
+ string 座机
+ }
+ 说明:仅用于信息展示
+}
+
+3.4保存访客记录
+{
+request:
+ {
+ string 学校id
+ int 访客：人员id
+ int 被访者：人员id
+ string 拜访事由：
+ string 备注：
+ }
+ response:
+ {
+ string 记录id OR 保存状态。
+ }
+ 说明:记录时间由数据库获得。
+}
+
+4.访客管理
+{
+ request:
+ {
+ string 学校id
+ }
+ response:
+ {
+ int 访客记录id
+ string 访客姓名
+ string 访客状态
+ }
+ 说明：查询访客记录按日期排序
+}
+
+4.1访客记录详情
+{
+ request:
+ {
+ string 学校id
+ int 访客记录id
+ }
+ response:
+ {
+ string 访客详情（所有字段）
+ int 拜访人id
+ string 拜访人姓名
+ string 拜访部门
+ string 拜访事由
+ string 访问状态
+ string 拜访时间
+ string 离开时间
+ }
+ 说明：
+}
+
+5.考勤记录
+{
+ request:
+ {
+ string 学校id
+ }
+ response:
+ {
+ int 人员id
+ string 签到状态
+ }
+}
+
+5.1签到详情
+{
+ request:
+ {
+ string 学校id
+ int 员工id
+ string 日期
+ }
+ response:
+ {
+ img 头像
+ string 卡号
+ string 姓名
+ string 性别
+ string 职务
+ string 部门/班级
+ string 考勤时间
+ string 地点
+ string 类型
+ }
+}
+
+6.查询拜访事由
+{
+ request:
+ {
+ }
+ response:
+ {
+ 事由id：事由
+ 事由id：事由
+ 事由id：事由
+ 事由id：事由
+ }
+ 说明：拜访事由列表
+}
+
+6.1增加拜访事由
+{
+ request:
+ {
+ 拜访事由1
+ }
+ response:
+ {
+ 接口：查询拜访事由
+ }
+}
+
+7.查询访客分类
+{
+ request:
+ {
+ }
+ response:
+ {
+ 访客类型id：访客类型
+ }
+ 说明：访客类型列表
+}
+
+8.查询证件类型
+{
+ request:
+ {
+ }
+ response:
+ {
+ 证件类型id：证件类型
+ }
+ 说明：证件类型列表
+}
+
+9.查询国籍列表
+{
+ request:
+ {
+ }
+ response:
+ {
+ 国籍id：国籍名称
+ }
+ 说明：国籍列表
+}
+
+
+
diff --git a/VisitFace/document/2.6.vpp b/VisitFace/document/2.6.vpp
new file mode 100644
index 0000000..e553e78
--- /dev/null
+++ b/VisitFace/document/2.6.vpp
Binary files differ
diff --git a/VisitFace/document/erdb api.txt b/VisitFace/document/erdb api.txt
new file mode 100644
index 0000000..374f374
--- /dev/null
+++ b/VisitFace/document/erdb api.txt
@@ -0,0 +1,305 @@
+#todo 浜鸿劯璇嗗埆閿欒锛堟敞鍐屻�佽瀹㈠彉鏇村憳宸ワ級鏃朵繚鎶や笟鍔℃暟鎹殑闂
+# Request鑰冭檻socket鐩存帴鍜屼汉鑴歌瘑鍒湇鍔″櫒浜や簰
+
+1. 瀹炴椂鐩戞帶
+1.1. 浜哄憳鍒嗙被鍒嗙被鍒楄〃(VisitorType)
+Request:
+{
+}
+Response:
+[
+ {
+ ID : "label"
+ }
+]
+
+1.2. ImageTypeID
+
+1.2. StatusID
+
+1.3. 浜鸿劯璇嗗埆 #todo 鑰冭檻灏佽涓�涓暣浣揳pi
+閫氳繃鍥惧儚鑾峰緱faceID
+Request:
+{
+ registerCompanyID : 123, // 鑻ヤ负-1鍒欏彧鎼滅储VisitFaceDB
+ imgs : [ "image base64" ] // 瀵瑰簲澶氫釜浜虹殑浜鸿劯鍥惧儚
+}
+Response:
+[
+ {
+ registerCompanyID : 123, //鎵句笉鍒拌繑鍥濾isitDBFaceID锛屾椤逛负-1
+ faceID : 1,
+ isVisitDBFaceID : false,
+ srcImgIdx : 1,
+ srcImgPosX : 123,
+ srcImgPosY : 456
+ },
+ {
+ faceID : -1, // 鎼滅储鏃犵粨鏋�
+ }
+]
+
+1.4. 浜鸿劯鎬讳綋淇℃伅鏌ヨ
+閫氳繃faceID鑾峰緱Person绠�瑕佷俊鎭�
+闇�瑕佹敮鎸佹壒閲忔煡璇�
+Request:
+{
+ companyID : 123,
+ faceID : 123,
+ isVisitDBFaceID : false // 濡傛灉涓簍rue鍒欏拷鐣ompanyID锛宖aceID璁や负鏄痸isitDBFaceID
+}
+Response:
+{
+ personID : 123, // 鏃犳晥鍊艰〃绀烘病鏈夊搴旂殑浜篒D
+ personTypeID : 1, // 浜哄憳鍒嗙被鍒楄〃
+ visitStatusID : 1, // 璁块棶鐘舵�� #鏂板缓琛ㄤ繚瀛樻暟鎹�
+ name : "name",
+ checkingCompany : [123, 456], // 鑰冨嫟鍏徃ID鍒楄〃
+ warning : false // 鏄惁涓鸿鍛�
+}
+
+1.5. 璁垮娉ㄥ唽锛堣2 浜哄憳娉ㄥ唽锛�
+
+1.6. 鏇存敼浜哄憳鑰冨嫟鐘舵�侊紙绛惧埌銆佺閫�銆佺绂伙級
+闇�瑕佹敮鎸佹壒閲忔煡璇�
+Request:
+{
+ placeID : 123,
+ personID : 123,
+ visitStatusID : 1 // 璁块棶鐘舵��
+}
+Response:
+鎴愬姛/閿欒缁撴灉
+
+1.7. 鏌ヨ浜哄憳鏉ヨ/绛惧埌鐘舵��
+闇�瑕佹敮鎸佹壒閲忔煡璇�
+Request:
+{
+ companyID : 1,
+ personID : 123,
+}
+Response:
+{
+ visitStatusID : 1 // 璁块棶鐘舵��
+}
+
+1.8. 鏇存敼浜哄憳鏉ヨ鐘舵�侊紙鏉ヨ鐧昏锛�
+瑙�3 娣诲姞鏉ヨ璁板綍
+
+2. 浜哄憳娉ㄥ唽
+2.1. 鍥界睄鍒楄〃
+2.2. 璇佷欢绫诲瀷
+2.3. 娉ㄥ唽浜哄憳
+Request:
+{
+ registerCompanyID : 123,
+ name : "",
+ companyName : "",
+ // ...
+ imgIdentity : "image base64"
+}
+Response:
+{
+ companyID : 123,
+ personID : 123
+}
+
+2.4. 娉ㄥ唽浜鸿劯
+Request:
+{
+ registerCompanyID : 123,
+ personID : 123,
+ imgs : [ "image base64" ] // 瀵瑰簲涓�涓汉鐨勮嫢骞蹭釜浜鸿劯鍥惧儚
+}
+Response:
+{
+ faceIDs : [ 123 ]
+}
+
+3. 鏉ヨ鐧昏
+3.1. 鑾峰緱鏉ヨ浜哄憳鍒楄〃
+杩斿洖鎸夊鍚嶇缉鍐欏崌搴忕殑缁撴灉
+Request:
+{
+ companyID : 123, // 璁惧鎵�鍦ㄥ鏍D
+ beginPage : 0,
+ endPage : 0
+}
+Response:
+[
+ {
+ personID : 123,
+ name : "aaa",
+ img : "image url" // 闈炲瓧绗︿覆琛ㄧず浣跨敤榛樿鍥炬爣
+ }
+]
+
+3.2. 鑾峰緱琚浜哄憳鍒楄〃
+杩斿洖鎸夊鍚嶇缉鍐欏崌搴忕殑缁撴灉
+Request:
+{
+ companyID : 123,
+ beginPage : 0,
+ endPage : 0
+}
+Response:
+[
+ {
+ personID : 123,
+ name : "aaa",
+ department : "aaa",
+ img : "image url" // 闈炲瓧绗︿覆琛ㄧず浣跨敤榛樿鍥炬爣
+ }
+]
+
+3.2. 鎼滅储
+(3. 4. 5. 6.)
+鏉ヨ浜哄憳锛屽鏋滄病鏈夌粰鍑烘悳绱㈠瓧娈垫椂锛屾樉绀烘湰鏍℃浘缁忔潵璁夸汉鍛樺垪琛╒isitStat锛涘鏋滅粰鍑哄叧閿瓧锛屽垯鎼滅储鍏ㄩ儴浜哄憳
+琚浜哄憳锛屾湰鍏徃鍛樺伐鍒楄〃
+Request:
+{
+ registerCompanyID : 123,
+ isVisitor : true
+ beginPage : 0,
+ endPage : 0,
+ nameSpell : ""
+}
+Response:
+{
+}
+
+#todo 琚鑰冭檻鍜屼汉鍛樺垪琛ㄥ悎骞�
+
+3.3. 鑾峰緱鏉ヨ/琚浜哄憳璇︾粏淇℃伅锛坴isitor/visitee锛�
+Request:
+{
+ personID : 123,
+ isVisitor : true
+}
+Response:
+{
+ companyID : 123,
+ name : "aaa",
+ companyName : "",
+ department : "aaa",
+ img : "image url" // 闈炲瓧绗︿覆琛ㄧず浣跨敤榛樿鍥炬爣
+ // ...
+}
+
+3.4. 娣诲姞鏉ヨ璁板綍
+Request:
+{
+ placeID : 123,
+ visitorPersonID : 123,
+ visiteePersonID : 123,
+ matter : "aaa", // 鏁板瓧琛ㄧず浣跨敤棰勫畾涔夋爣绛綢D
+ remark : ""
+}
+Response:
+鎴愬姛/閿欒缁撴灉
+
+3.5. 鑾峰緱鎷滆浜嬬敱閫夐」鍒楄〃
+Request:
+{
+}
+Response:
+[
+ {
+ ID : "label"
+ }
+]
+
+4. 鐢佃瘽鍛煎彨
+4.1. 鑾峰緱浜哄憳鍒楄〃锛堝悓琚浜哄憳鍒楄〃锛�
+
+4.2. 娣诲姞鍛煎彨璁板綍
+
+5. 璁垮绠＄悊
+5.1. 鑾峰緱鏉ヨ鍒楄〃
+Request:
+{
+ companyID : 123,
+ beginDt : "",
+ endDt : ""
+}
+Response:
+[
+ {
+ visitID : 1,
+ visitorPersonID : 123,
+ visitorName : "",
+ lastStatusID : 1,
+ dt : ""
+ }
+]
+
+5.2. 璁垮淇℃伅
+
+
+5.2. 鑾峰緱鏉ヨ璇︾粏淇℃伅
+Request:
+{
+ visitID : 1
+}
+Response:
+{
+ visitorPersonID
+ visitorName : "",
+ // ...
+ visiteePersonID : 123,
+ // ...
+ imgChar : "image url",
+ imgIdentity : "image url"
+}
+
+6. 鑰冨嫟璁板綍
+6.1. 鑾峰緱鑰冨嫟鍒楄〃
+鏍规嵁鏃ユ湡銆乸ersonID鑱氱被
+Request:
+{
+ companyID : 123,
+ beginDt : "",
+ endDt : ""
+}
+Response:
+[
+ {
+ personID : 123,
+ name : "",
+ lastStatusID : 1,
+ dt : ""
+ }
+]
+
+6.2. 鑾峰緱鑰冨嫟璇︾粏淇℃伅
+Request:
+{
+ personID : 123
+ beginDt : "",
+ endDt : ""
+}
+Response:
+{
+ {
+ id : 123,
+ place : "",
+ // ...
+ }
+}
+
+6.2. 杩斿洖浜哄憳璇︾粏淇℃伅API
+瑙� 3.3.
+
+
+7. 閰嶇疆
+
+8. 鍏朵粬瀹炰綋鎿嶄綔
+
+
+9. 鎬讳綋鎺ュ彛
+9.1. 閫氱敤鎴愬姛/閿欒缁撴灉
+Response:
+{
+ errcode : 0, // 0琛ㄧず鎵ц鎴愬姛锛屽惁鍒欎负澶辫触閿欒浠ｇ爜
+ msg:"aaaaa" // 鎵ц缁撴灉闄勫姞娑堟伅
+}
diff --git a/VisitFace/document/erdb.vpp b/VisitFace/document/erdb.vpp
new file mode 100644
index 0000000..2858e4f
--- /dev/null
+++ b/VisitFace/document/erdb.vpp
Binary files differ
--
Gitblit v1.8.0