添加接口描述 sql

houxiao

2017-03-13 fe09fbb10ac785fe47d787b904cc7e2db3d5754f

添加接口描述 sql

git-svn-id: http://192.168.1.226/svn/proxy@149 454eff88-639b-444f-9e54-f578c98de674

 VisitFace/document/erdb api½Ó¿ÚÃèÊö.txt

New file
@@ -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, //找不到返回VisitDBFaceID，此项为-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 // å¦‚果为true则忽略companyID，faceID认为是visitDBFaceID

}

Response:

{

    personID : 123, // æ— æ•ˆå€¼è¡¨ç¤ºæ²¡æœ‰å¯¹åº”的人ID

    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, // è®¾å¤‡æ‰€åœ¨å­¦æ ¡ID

    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.)

来访人员，如果没有给出搜索字段时，显示本校曾经来访人员列表VisitStat；如果给出关键字，则搜索全部人员

被访人员，本公司员工列表

Request:

{

    registerCompanyID : 123,

    isVisitor : true

    beginPage : 0,

    endPage : 0,

    nameSpell : ""

}

Response:

{

}



#todo è¢«è®¿è€ƒè™‘和人员列表合并



3.3. èŽ·å¾—来访/被访人员详细信息（visitor/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", // æ•°å­—表示使用预定义标签ID

    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. èŽ·å¾—考勤列表

根据日期、personID聚类

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" // æ‰§è¡Œç»“果附加消息

}


 VisitFace/document/erdb.vpp

Binary files differ