add VisitFace doc

houxiao

2017-02-08 165ef01356d14cb3378cc3dc89e889f89212ac0c

add VisitFace doc

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

 VisitFace/document/2.6 api.json

New file
@@ -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：国籍名称
    }
    说明：国籍列表
}




 VisitFace/document/2.6.vpp

Binary files differ

 VisitFace/document/erdb api.txt

New file
@@ -0,0 +1,305 @@
#todo 人脸识别错误（注册、访客变更员工）时保护业务数据的问题

# Request考虑socket直接和人脸识别服务器交互



1. 实时监控

1.1. 人员分类分类列表(VisitorType)

Request:

{

}

Response:

[

    {

        ID : "label"

    }

]



1.2. ImageTypeID



1.2. StatusID



1.3. 人脸识别 #todo 考虑封装一个整体api

通过图像获得faceID

Request:

{

    registerCompanyID : 123, // 若为-1则只搜索VisitFaceDB

    imgs : [ "image base64" ] // 对应多个人的人脸图像

}

Response:

[

    {

        registerCompanyID : 123, //找不到返回VisitDBFaceID，此项为-1

        faceID : 1,

        isVisitDBFaceID : false,

        srcImgIdx : 1,

        srcImgPosX : 123,

        srcImgPosY : 456

    },

    {

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