From fe09fbb10ac785fe47d787b904cc7e2db3d5754f Mon Sep 17 00:00:00 2001
From: houxiao <houxiao@454eff88-639b-444f-9e54-f578c98de674>
Date: 星期一, 13 三月 2017 18:55:20 +0800
Subject: [PATCH] 添加接口描述 sql
---
VisitFace/document/erdb api接口描述.txt | 357 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VisitFace/document/erdb.vpp | 0
2 files changed, 357 insertions(+), 0 deletions(-)
diff --git "a/VisitFace/document/erdb api\346\216\245\345\217\243\346\217\217\350\277\260.txt" "b/VisitFace/document/erdb api\346\216\245\345\217\243\346\217\217\350\277\260.txt"
new file mode 100644
index 0000000..8611faf
--- /dev/null
+++ "b/VisitFace/document/erdb api\346\216\245\345\217\243\346\217\217\350\277\260.txt"
@@ -0,0 +1,357 @@
+
+0.1浜ゆ崲authorizationID
+Request:
+{
+ authorizationID: "aaaaa"
+}
+Response:
+{
+ registerCompanyID : 1,
+ placeID : 1
+ companyName : "aaa",
+ placeLabel: "aaaaa"
+}
+
+select b.CompanyID as registerCompanyID, b.ID as placeID, a.name as companyName, b.label as placeLabel from Company a, Place b
+ where a.ID = b.CompanyID and authorizationID = "$authorizationID"
+
+
+1. 瀹炴椂鐩戞帶
+1.1. 浜哄憳鍒嗙被鍒嗙被鍒楄〃(VisitorType)
+Request:
+{
+ companyID : 1
+}
+Response:
+[
+ {
+ ID : "label"
+ }
+]
+
+select ID, distinct label from VisitorType where RegisterCompanyID = 0 or RegisterCompanyID = "$companyID"
+
+1.2. ImageTypeID
+
+enum ImageTypeID
+{
+ Face = 1, // 鐓х墖
+ FaceUploaded = 2, // 涓婁紶鐓х墖
+ Icon, // 鍥炬爣
+
+
+}
+
+1.2. StatusID
+
+1.3. 浜鸿劯璇嗗埆
+閫氳繃鍥惧儚鑾峰緱faceID
+Request:
+{
+ registerCompanyID : 123, // 鑻ヤ负-1鍒欏彧鎼滅储VisitFaceDB
+ imgs : [ "image base64" ] // 瀵瑰簲澶氫釜浜虹殑浜鸿劯鍥惧儚
+}
+Response:
+[
+ {
+ registerCompanyID : 123, //鎵句笉鍒拌繑鍥濾isitDBFaceID锛屾椤逛负-1
+ faceID : 1,
+ isVisitDBFaceID : false, // <dbid=-1, faceid!=-1> : true, <dbid!=-1, faceid!=-1> : false
+ srcImgIdx : 1,
+ srcImgPosX : 123,
+ srcImgPosY : 456,
+ srcImgPosW : 123,
+ srcImgPosH : 456
+ },
+ {
+ faceID : -1, // 鎼滅储鏃犵粨鏋� <dbid=-1, 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.6.1. 浜鸿劯璇嗗埆鍙婄姸鎬佷慨鏀�
+鏁村悎锛氶�氳繃浜鸿劯鍥惧儚锛屽畬鎴愮姸鎬佷慨鏀癸紝杩斿洖褰撳墠鐘舵��
+锛堟暣鍚�1.3. 1.4. 1.6.锛�
+Request:
+{
+ placeID : 123, // 鑻ヤ负-1鍒欏彧鎼滅储VisitFaceDB
+ visitStatusID : 1 // 绛惧埌銆佺閫�/绛剧
+ imgs : [ "image base64" ] // 瀵瑰簲澶氫釜浜虹殑浜鸿劯鍥惧儚
+}
+Response:
+[
+ {
+ personID : 123,
+ visitStatusID : 1 // 鏇存柊涔嬪悗鐨勮闂姸鎬�
+ },
+ {
+ faceID : -1, // 浜鸿劯鎼滅储鏃犵粨鏋�
+ },
+ {
+ //涓氬姟閿欒锛� 9.1. 閫氱敤鎴愬姛/閿欒缁撴灉
+ }
+]
+
+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
index f7fbffc..375eb97 100644
--- a/VisitFace/document/erdb.vpp
+++ b/VisitFace/document/erdb.vpp
Binary files differ
--
Gitblit v1.8.0