衢州三圈一道名单库 API

概览

名单库相关接口

版本信息

版本 : 1.0.0-RELEASE

联系方式

名字 : yangziyan
邮箱 : yangziyan@hikvision.com.cn

许可信息

服务条款 : /

URI scheme

域名 : 127.0.0.1:22008
基础路径 : /ctm01ipac

标签

• common-controller : Common Controller
• follow-controller : 关注相关接口
• human-controller : 人员名单库操作相关接口
• lib-controller : 名单库相关接口
• tag-controller : 标签相关接口
• user-controller : 用户、部门接口
• vehicle-controller : 车辆相关接口
• web-controller : Web Controller

资源

Common-controller

Common Controller

查询数据字典

POST /common/findDataDict

参数

类型	名称	说明	类型
Body	findDataDictVO 必填	findDataDictVO	FindDataDictVO

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/common/findDataDict

请求 body

json :
{
  "typeCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

getImageStream

GET /common/getImageStream.do

响应

HTTP代码	说明	类型
200	OK	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/common/getImageStream.do

上传人脸图片

POST /uploadImage

响应

HTTP代码	说明	类型
200	OK	BaseResult«object»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/uploadImage

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Follow-controller

关注相关接口

添加关注

POST /follow/add

参数

类型	名称	说明	类型
Body	followVo 必填	followVo	关注

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/follow/add

请求 body

json :
{
  "libCode" : "string",
  "libType" : 0,
  "licenseColor" : "string",
  "resourceId" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

取消关注

POST /follow/cancel

参数

类型	名称	说明	类型
Body	followVo 必填	followVo	关注

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/follow/cancel

请求 body

json :
{
  "libCode" : "string",
  "libType" : 0,
  "licenseColor" : "string",
  "resourceId" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Human-controller

人员名单库操作相关接口

添加人员

POST /human

参数

类型	名称	说明	类型
Body	humanAddVo 必填	humanAddVo	添加更新人员对象

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/human

请求 body

json :
{
  "address" : "string",
  "birthday" : "string",
  "bkgPicUrl" : "string",
  "caseCode" : "string",
  "certificateNumber" : "string",
  "certificateType" : 0,
  "city" : "string",
  "extFields" : [ {
    "fieldKey" : "string",
    "fieldName" : "string",
    "fieldValue" : "string"
  } ],
  "facePicUrl" : "string",
  "gender" : "string",
  "humanId" : "string",
  "libCode" : "string",
  "managePolice" : "string",
  "name" : "string",
  "nation" : "string",
  "nativeCountyCode" : "string",
  "policePhone" : "string",
  "province" : "string",
  "residenceCountyCode" : "string",
  "targetModelData" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

upadte

PUT /human

参数

类型	名称	说明	类型
Body	humanAddVo 必填	humanAddVo	添加更新人员对象

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/human

请求 body

json :
{
  "address" : "string",
  "birthday" : "string",
  "bkgPicUrl" : "string",
  "caseCode" : "string",
  "certificateNumber" : "string",
  "certificateType" : 0,
  "city" : "string",
  "extFields" : [ {
    "fieldKey" : "string",
    "fieldName" : "string",
    "fieldValue" : "string"
  } ],
  "facePicUrl" : "string",
  "gender" : "string",
  "humanId" : "string",
  "libCode" : "string",
  "managePolice" : "string",
  "name" : "string",
  "nation" : "string",
  "nativeCountyCode" : "string",
  "policePhone" : "string",
  "province" : "string",
  "residenceCountyCode" : "string",
  "targetModelData" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

批量删除人员

POST /human/delete

参数

类型	名称	说明	类型
Body	humanDelVo 必填	humanDelVo	批量删除人员

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/human/delete

请求 body

json :
{
  "humanIds" : [ "string" ],
  "libCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

下载模版

GET /human/downloadCustomTemplate

响应

HTTP代码	说明	类型
200	OK	BaseResult«string»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/human/downloadCustomTemplate

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "string",
  "msg" : "string",
  "type" : 0
}

导入人员

POST /human/importCustomData

参数

类型	名称	说明	类型
Query	personLibId 必填	personLibId	string

响应

HTTP代码	说明	类型
200	OK	BaseResult«string»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/human/importCustomData

请求 query

json :
{
  "personLibId" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "string",
  "msg" : "string",
  "type" : 0
}

展示人员

POST /human/list

参数

类型	名称	说明	类型
Body	humanPagramVo 必填	humanPagramVo	HumanPagramVo

响应

HTTP代码	说明	类型
200	OK	BasePage«添加更新人员对象»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/human/list

请求 body

json :
{
  "certificateNumber" : "string",
  "certificateType" : 0,
  "city" : "string",
  "gender" : "string",
  "libCode" : "string",
  "name" : "string",
  "nation" : "string",
  "pageNo" : 0,
  "pageSize" : 0,
  "province" : "string"
}

HTTP响应示例

响应 200

json :
{
  "list" : [ {
    "address" : "string",
    "birthday" : "string",
    "bkgPicUrl" : "string",
    "caseCode" : "string",
    "certificateNumber" : "string",
    "certificateType" : 0,
    "city" : "string",
    "extFields" : [ {
      "fieldKey" : "string",
      "fieldName" : "string",
      "fieldValue" : "string"
    } ],
    "facePicUrl" : "string",
    "gender" : "string",
    "humanId" : "string",
    "libCode" : "string",
    "managePolice" : "string",
    "name" : "string",
    "nation" : "string",
    "nativeCountyCode" : "string",
    "policePhone" : "string",
    "province" : "string",
    "residenceCountyCode" : "string",
    "targetModelData" : "string"
  } ],
  "total" : 0
}

迁移人员

POST /human/move

参数

类型	名称	说明	类型
Body	moveVo 必填	moveVo	人脸迁移

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/human/move

请求 body

json :
{
  "humanIds" : [ "string" ],
  "libCode" : "string",
  "targetLibCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Lib-controller

名单库相关接口

保存名单库

POST /lib

参数

类型	名称	说明	类型
Body	libAddVo 必填	libAddVo	名单库添加对象

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/lib

请求 body

json :
{
  "describe" : "string",
  "extFields" : [ {
    "fieldKey" : "string",
    "fieldName" : "string"
  } ],
  "libCode" : "string",
  "libName" : "string",
  "libType" : 0,
  "shareType" : 0,
  "sharedUserIds" : [ "string" ],
  "tagCodes" : [ "string" ]
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

修改名单库

PUT /lib

参数

类型	名称	说明	类型
Body	libAddVo 必填	libAddVo	名单库添加对象

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/lib

请求 body

json :
{
  "describe" : "string",
  "extFields" : [ {
    "fieldKey" : "string",
    "fieldName" : "string"
  } ],
  "libCode" : "string",
  "libName" : "string",
  "libType" : 0,
  "shareType" : 0,
  "sharedUserIds" : [ "string" ],
  "tagCodes" : [ "string" ]
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

通过名单库类型获取到对应的扩展字段

GET /lib/extField

参数

类型	名称	说明	类型
Body	libCode 可选	获取自定义扩展字段，两者填其一	string
Body	libType 可选	获取库类型扩展字段 0-人脸名单库，1-车辆名单库，2-身份证名单库，3-单人脸库	integer (int32)

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«ExtFieldVo»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/lib/extField

请求 body

json :
{ }

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "fieldKey" : "string",
    "fieldName" : "string"
  } ],
  "msg" : "string",
  "type" : 0
}

获取名单库列表

GET /lib/list

参数

类型	名称	说明	类型
Body	dto 可选	dto	条件查询名单库对象

响应

HTTP代码	说明	类型
200	OK	BaseResult«BasePage«展示名单库列表对象»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/lib/list

请求 body

json :
{
  "libName" : "string",
  "libType" : 0,
  "pageNo" : 0,
  "pageSize" : 0,
  "tagCodes" : [ "string" ]
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "list" : [ {
      "capacity" : 0,
      "createTime" : "string",
      "createUserDept" : "string",
      "createUserId" : "string",
      "createUserName" : "string",
      "flag" : 0,
      "libCode" : "string",
      "libName" : "string",
      "shared" : true,
      "tagList" : [ {
        "tagCode" : "string",
        "tagName" : "string"
      } ]
    } ],
    "total" : 0
  },
  "msg" : "string",
  "type" : 0
}

得到名单库详情

GET /lib/{libCode}

参数

类型	名称	说明	类型
Path	libCode 必填	libCode	string

响应

HTTP代码	说明	类型
200	OK	BaseResult«LibVo»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/lib/string

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "capacity" : 0,
    "createTime" : "string",
    "createUserId" : "string",
    "describe" : "string",
    "extFields" : [ {
      "fieldKey" : "string",
      "fieldName" : "string"
    } ],
    "flag" : 0,
    "libCode" : "string",
    "libName" : "string",
    "libType" : 0,
    "modelingCapacity" : 0,
    "shareType" : 0,
    "sharedUserIds" : [ "string" ],
    "tagList" : [ {
      "tagCode" : "string",
      "tagName" : "string"
    } ]
  },
  "msg" : "string",
  "type" : 0
}

删除名单库

DELETE /lib/{libCode}

参数

类型	名称	说明	类型
Path	libCode 必填	libCode	string

响应

HTTP代码	说明	类型
200	OK	BaseResult
204	No Content	无内容
401	Unauthorized	无内容
403	Forbidden	无内容

生成

• */*

HTTP请求示例

请求 path

/lib/string

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Tag-controller

标签相关接口

新增标签

POST /tag

参数

类型	名称	说明	类型
Body	tagVo 必填	tagVo	TagVo

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/tag

请求 body

json :
{
  "extFields" : [ {
    "fieldKey" : "string",
    "fieldName" : "string"
  } ],
  "tagCode" : "string",
  "tagName" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

修改标签

PUT /tag

参数

类型	名称	说明	类型
Body	tagVo 必填	tagVo	TagVo

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/tag

请求 body

json :
{
  "extFields" : [ {
    "fieldKey" : "string",
    "fieldName" : "string"
  } ],
  "tagCode" : "string",
  "tagName" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

通过标签id列表获取对应标签详情列表

POST /tag/list

参数

类型	名称	说明	类型
Body	tagCodes 可选	查询标签以及对应扩展字段 标签id数组	< string > array

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«TagVo»»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/tag/list

请求 body

json :
[ "string" ]

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "extFields" : [ {
      "fieldKey" : "string",
      "fieldName" : "string"
    } ],
    "tagCode" : "string",
    "tagName" : "string"
  } ],
  "msg" : "string",
  "type" : 0
}

获取某个名单拥有的标签

GET /tag/list/{libCode}

参数

类型	名称	说明	类型
Path	libCode 必填	libCode	string

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«TagSimpleVo»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/tag/list/string

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "tagCode" : "string",
    "tagName" : "string"
  } ],
  "msg" : "string",
  "type" : 0
}

获取全部展示标签列表

GET /tag/listAll

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«TagSimpleVo»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/tag/listAll

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "tagCode" : "string",
    "tagName" : "string"
  } ],
  "msg" : "string",
  "type" : 0
}

获取标签详情

GET /tag/{tagCode}

参数

类型	名称	说明	类型
Path	tagCode 必填	tagCode	string

响应

HTTP代码	说明	类型
200	OK	BaseResult«TagVo»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/tag/string

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "extFields" : [ {
      "fieldKey" : "string",
      "fieldName" : "string"
    } ],
    "tagCode" : "string",
    "tagName" : "string"
  },
  "msg" : "string",
  "type" : 0
}

删除标签

DELETE /tag/{tagCode}

参数

类型	名称	说明	类型
Path	tagCode 必填	tagCode	string

响应

HTTP代码	说明	类型
200	OK	BaseResult
204	No Content	无内容
401	Unauthorized	无内容
403	Forbidden	无内容

生成

• */*

HTTP请求示例

请求 path

/tag/string

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

User-controller

用户、部门接口

list

POST /user/list

参数

类型	名称	说明	类型
Body	vo 可选	vo	点击确定时获取所有用户

响应

HTTP代码	说明	类型
200	OK	BaseResult«List«UserSimpleVo»»
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/user/list

请求 body

json :
{
  "deptList" : [ "string" ],
  "userList" : [ {
    "userId" : "string",
    "userName" : "string"
  } ]
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : [ {
    "userId" : "string",
    "userName" : "string"
  } ],
  "msg" : "string",
  "type" : 0
}

getNode

GET /user/node/{departIndexCode}

参数

类型	名称	说明	类型
Path	departIndexCode 可选	部门id 传0表示请求根节点	string

响应

HTTP代码	说明	类型
200	OK	BaseResult«部门节点»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/user/node/string

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "deptList" : [ {
      "deptIndexCode" : "string",
      "existsChild" : true,
      "name" : "string"
    } ],
    "userList" : [ {
      "userIndexCode" : "string",
      "username" : "string"
    } ]
  },
  "msg" : "string",
  "type" : 0
}

Vehicle-controller

车辆相关接口

新增

POST /vehicle/add

参数

类型	名称	说明	类型
Body	vo 可选	vo	VehicleVO

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/vehicle/add

请求 body

json :
{
  "address" : "string",
  "carBrand" : "string",
  "carColor" : "string",
  "carModel" : "string",
  "carType" : "string",
  "extFields" : {
    "string" : "string"
  },
  "id" : "string",
  "idCardNo" : "string",
  "identifyNo" : "string",
  "isFollow" : 0,
  "issueAuth" : "string",
  "libCode" : "string",
  "licenseColor" : "string",
  "licenseNo" : "string",
  "ownerName" : "string",
  "phoneNumber" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

删除车辆

POST /vehicle/delete/{libCode}

参数

类型	名称	说明	类型
Path	libCode 必填	libCode	string
Body	list 可选	list	< VehicleDelDTO > array

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/vehicle/delete/string

请求 body

json :
[ {
  "licenseColor" : "string",
  "licenseNo" : "string"
} ]

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

迁移车辆

POST /vehicle/move

参数

类型	名称	说明	类型
Body	vehicleMoveVo 必填	vehicleMoveVo	车辆迁移

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/vehicle/move

请求 body

json :
{
  "libCode" : "string",
  "list" : [ {
    "address" : "string",
    "carBrand" : "string",
    "carColor" : "string",
    "carModel" : "string",
    "carType" : "string",
    "extFields" : {
      "string" : "string"
    },
    "id" : "string",
    "idCardNo" : "string",
    "identifyNo" : "string",
    "isFollow" : 0,
    "issueAuth" : "string",
    "libCode" : "string",
    "licenseColor" : "string",
    "licenseNo" : "string",
    "ownerName" : "string",
    "phoneNumber" : "string"
  } ],
  "targetLibCode" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

列表

GET /vehicle/page/{pageSize}/{pageNo}

参数

类型	名称	说明	类型
Path	pageNo 必填	pageNo	integer (int32)
Path	pageSize 必填	pageSize	integer (int32)
Query	isFollow 可选	是否关注	integer (int32)
Query	libCode 可选	名单库id	string
Query	licenseColor 可选	车牌颜色	string
Query	licenseNo 可选	车牌号	string

响应

HTTP代码	说明	类型
200	OK	BaseResult«BasePage«VehicleVO»»
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/vehicle/page/0/0

请求 query

json :
{
  "isFollow" : 0,
  "libCode" : "string",
  "licenseColor" : "string",
  "licenseNo" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : {
    "list" : [ {
      "address" : "string",
      "carBrand" : "string",
      "carColor" : "string",
      "carModel" : "string",
      "carType" : "string",
      "extFields" : {
        "string" : "string"
      },
      "id" : "string",
      "idCardNo" : "string",
      "identifyNo" : "string",
      "isFollow" : 0,
      "issueAuth" : "string",
      "libCode" : "string",
      "licenseColor" : "string",
      "licenseNo" : "string",
      "ownerName" : "string",
      "phoneNumber" : "string"
    } ],
    "total" : 0
  },
  "msg" : "string",
  "type" : 0
}

更新

POST /vehicle/update

参数

类型	名称	说明	类型
Body	vo 可选	vo	VehicleVO

响应

HTTP代码	说明	类型
200	OK	BaseResult
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/vehicle/update

请求 body

json :
{
  "address" : "string",
  "carBrand" : "string",
  "carColor" : "string",
  "carModel" : "string",
  "carType" : "string",
  "extFields" : {
    "string" : "string"
  },
  "id" : "string",
  "idCardNo" : "string",
  "identifyNo" : "string",
  "isFollow" : 0,
  "issueAuth" : "string",
  "libCode" : "string",
  "licenseColor" : "string",
  "licenseNo" : "string",
  "ownerName" : "string",
  "phoneNumber" : "string"
}

HTTP响应示例

响应 200

json :
{
  "code" : "string",
  "data" : "object",
  "msg" : "string",
  "type" : 0
}

Web-controller

Web Controller

hello

POST /hello

响应

HTTP代码	说明	类型
200	OK	string
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/hello

HTTP响应示例

响应 200

json :
"string"

hello

GET /hello

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/hello

HTTP响应示例

响应 200

json :
"string"

hello

PUT /hello

响应

HTTP代码	说明	类型
200	OK	string
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/hello

HTTP响应示例

响应 200

json :
"string"

hello

DELETE /hello

响应

HTTP代码	说明	类型
200	OK	string
204	No Content	无内容
401	Unauthorized	无内容
403	Forbidden	无内容

生成

• */*

HTTP请求示例

请求 path

/hello

HTTP响应示例

响应 200

json :
"string"

hello

PATCH /hello

响应

HTTP代码	说明	类型
200	OK	string
204	No Content	无内容
401	Unauthorized	无内容
403	Forbidden	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/hello

HTTP响应示例

响应 200

json :
"string"

hello

HEAD /hello

响应

HTTP代码	说明	类型
200	OK	string
204	No Content	无内容
401	Unauthorized	无内容
403	Forbidden	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/hello

HTTP响应示例

响应 200

json :
"string"

hello

OPTIONS /hello

响应

HTTP代码	说明	类型
200	OK	string
204	No Content	无内容
401	Unauthorized	无内容
403	Forbidden	无内容

消耗

• application/json

生成

• */*

HTTP请求示例

请求 path

/hello

HTTP响应示例

响应 200

json :
"string"

redirectJJQ

GET /redirectJJQ

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/redirectJJQ

HTTP响应示例

响应 200

json :
"string"

redirectJJQ

GET /redirectJJQ.do

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/redirectJJQ.do

HTTP响应示例

响应 200

json :
"string"

redirectRFID

GET /redirectRFID

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/redirectRFID

HTTP响应示例

响应 200

json :
"string"

redirectRFID

GET /redirectRFID.do

响应

HTTP代码	说明	类型
200	OK	string
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

生成

• */*

HTTP请求示例

请求 path

/redirectRFID.do

HTTP响应示例

响应 200

json :
"string"

定义

BasePage«VehicleVO»

名称	说明	类型
list 可选	样例 : [ "[vehiclevo](#vehiclevo)" ]	< VehicleVO > array
total 可选	样例 : 0	integer (int64)

BasePage«展示名单库列表对象»

名称	说明	类型
list 可选	样例 : [ "[639533ea7551f0c2cc3baa6ba3064dca](#639533ea7551f0c2cc3baa6ba3064dca)" ]	< 展示名单库列表对象 > array
total 可选	样例 : 0	integer (int64)

BasePage«添加更新人员对象»

名称	说明	类型
list 可选	样例 : [ "[5ea08e7fe13dd3f4191fdc1b6b93c82a](#5ea08e7fe13dd3f4191fdc1b6b93c82a)" ]	< 添加更新人员对象 > array
total 可选	样例 : 0	integer (int64)

BaseResult

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "object"	object
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«BasePage«VehicleVO»»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "[361106609fca1f8867debbb702ed6a5e](#361106609fca1f8867debbb702ed6a5e)"	BasePage«VehicleVO»
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«BasePage«展示名单库列表对象»»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "[102e75db3f3e9daae4beabc0046be3f6](#102e75db3f3e9daae4beabc0046be3f6)"	BasePage«展示名单库列表对象»
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«LibVo»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "[libvo](#libvo)"	LibVo
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«List«ExtFieldVo»»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : [ "[extfieldvo](#extfieldvo)" ]	< ExtFieldVo > array
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«List«TagSimpleVo»»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : [ "[tagsimplevo](#tagsimplevo)" ]	< TagSimpleVo > array
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«List«TagVo»»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : [ "[tagvo](#tagvo)" ]	< TagVo > array
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«List«UserSimpleVo»»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : [ "[usersimplevo](#usersimplevo)" ]	< UserSimpleVo > array
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«TagVo»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "[tagvo](#tagvo)"	TagVo
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«object»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "object"	object
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«string»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "string"	string
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

BaseResult«部门节点»

名称	说明	类型
code 可选	样例 : "string"	string
data 可选	样例 : "[8bf33e0817c1fbd74e310a4be6f97177](#8bf33e0817c1fbd74e310a4be6f97177)"	部门节点
msg 可选	样例 : "string"	string
type 可选	样例 : 0	integer (int32)

ExtFieldVo

名称	说明	类型
fieldKey 可选	扩展字段id 样例 : "string"	string
fieldName 可选	扩展字段名称 样例 : "string"	string

FindDataDictVO

名称	说明	类型
typeCode 可选	样例 : "string"	string

HumanPagramVo

名称	说明	类型
certificateNumber 可选	证件号码 样例 : "string"	string
certificateType 可选	证件类型 样例 : 0	integer (int32)
city 可选	城市 样例 : "string"	string
gender 可选	性别 样例 : "string"	string
libCode 可选	名单库id 样例 : "string"	string
name 可选	姓名 样例 : "string"	string
nation 可选	民族 样例 : "string"	string
pageNo 可选	当前页 样例 : 0	integer (int32)
pageSize 可选	每页数量 样例 : 0	integer (int32)
province 可选	省份 样例 : "string"	string

LibVo

名称	说明	类型
capacity 可选	库名单总数 样例 : 0	integer (int32)
createTime 可选	名单库创建时间 样例 : "string"	string
createUserId 可选	名单库创建人 样例 : "string"	string
describe 可选	名单库备注信息 样例 : "string"	string
extFields 可选	名单库自身的关联扩展字段列表 样例 : [ "[extfieldvo](#extfieldvo)" ]	< ExtFieldVo > array
flag 可选	库性质：0-基本库 1-常规库 样例 : 0	integer (int32)
libCode 可选	名单库id 样例 : "string"	string
libName 可选	名单库名称 样例 : "string"	string
libType 可选	名单库类型 0-人脸名单库，1-车辆名单库，2-身份证名单库，3-单人脸库 样例 : 0	integer (int32)
modelingCapacity 可选	库名单建模成功总数 样例 : 0	integer (int32)
shareType 可选	共享类型：0-公开 1-部分公开 3-私密 样例 : 0	integer (int32)
sharedUserIds 可选	名单库关联的用户Id列表 样例 : [ "string" ]	< string > array
tagList 可选	名单库关联的标签Id列表 样例 : [ "[tagsimplevo](#tagsimplevo)" ]	< TagSimpleVo > array

TagSimpleVo

名称	说明	类型
tagCode 可选	标签id 样例 : "string"	string
tagName 可选	标签名称 样例 : "string"	string

TagVo

名称	说明	类型
extFields 可选	扩展字段列表 样例 : [ "[extfieldvo](#extfieldvo)" ]	< ExtFieldVo > array
tagCode 可选	标签id 样例 : "string"	string
tagName 可选	标签名称 样例 : "string"	string

UserSimpleVo

名称	说明	类型
userId 可选	用户id 样例 : "string"	string
userName 可选	用户名 样例 : "string"	string

VehicleDelDTO

名称	说明	类型
licenseColor 可选	样例 : "string"	string
licenseNo 可选	样例 : "string"	string

VehicleVO

名称	说明	类型
address 可选	车主地址 样例 : "string"	string
carBrand 可选	车辆品牌 样例 : "string"	string
carColor 可选	车辆颜色 样例 : "string"	string
carModel 可选	样例 : "string"	string
carType 可选	车辆型号 样例 : "string"	string
extFields 可选	其它字段 样例 : {<br> "string" : "string"<br>}	< string, string > map
id 可选	id 样例 : "string"	string
idCardNo 可选	车主身份证号 样例 : "string"	string
identifyNo 可选	代号识别 样例 : "string"	string
isFollow 可选	是否关注 0 不关注 1 关注 样例 : 0	integer (int32)
issueAuth 可选	发证机关 样例 : "string"	string
libCode 可选	名单库 样例 : "string"	string
licenseColor 可选	车牌号颜色 样例 : "string"	string
licenseNo 可选	车牌号 样例 : "string"	string
ownerName 可选	车主姓名 样例 : "string"	string
phoneNumber 可选	车主联系方式 样例 : "string"	string

人脸迁移

名称	说明	类型
humanIds 可选	人员id列表 样例 : [ "string" ]	< string > array
libCode 可选	迁移名单库id 样例 : "string"	string
targetLibCode 可选	迁移至名单库id 样例 : "string"	string

关注

名称	说明	类型
libCode 可选	名单库id 样例 : "string"	string
libType 可选	名单库类型 样例 : 0	integer (int32)
licenseColor 可选	车牌颜色 样例 : "string"	string
resourceId 可选	资源id 人脸库为人脸id，车辆库为车辆车牌号 样例 : "string"	string

名单展示扩展字段

名称	说明	类型
fieldKey 可选	扩展字段id 样例 : "string"	string
fieldName 可选	扩展字段名称 样例 : "string"	string
fieldValue 可选	扩展字段对应value 样例 : "string"	string

名单库添加对象

名称	说明	类型
describe 可选	名单库备注信息 样例 : "string"	string
extFields 可选	名单库自身的关联扩展字段列表 样例 : [ "[extfieldvo](#extfieldvo)" ]	< ExtFieldVo > array
libCode 可选	名单库id 样例 : "string"	string
libName 可选	名单库名称 样例 : "string"	string
libType 可选	名单库类型 0-人脸名单库，1-车辆名单库，2-身份证名单库，3-单人脸库 样例 : 0	integer (int32)
shareType 可选	共享类型：0-公开 1-部分公开 3-私密 样例 : 0	integer (int32)
sharedUserIds 可选	名单库关联的用户Id列表 样例 : [ "string" ]	< string > array
tagCodes 可选	名单库关联的标签Id列表 样例 : [ "string" ]	< string > array

展示名单库列表对象

名称	说明	类型
capacity 可选	库名单总数 样例 : 0	integer (int32)
createTime 可选	名单库创建时间 样例 : "string"	string
createUserDept 可选	名单库创建人部门 样例 : "string"	string
createUserId 可选	名单库创建人 共享人 样例 : "string"	string
createUserName 可选	名单库创建人姓名 样例 : "string"	string
flag 可选	库性质：0-基本库 1-常规库 样例 : 0	integer (int32)
libCode 可选	名单库id 样例 : "string"	string
libName 可选	名单库名称 样例 : "string"	string
shared 可选	是否是被共享的 样例 : true	boolean
tagList 可选	标签列表 样例 : [ "[tagsimplevo](#tagsimplevo)" ]	< TagSimpleVo > array

批量删除人员

名称	说明	类型
humanIds 可选	名单库id列表 样例 : [ "string" ]	< string > array
libCode 可选	名单库id 样例 : "string"	string

条件查询名单库对象

名称	说明	类型
libName 可选	名单库名字 样例 : "string"	string
libType 可选	名单库类型 0-人脸名单库，1-车辆名单库，2-身份证名单库，3-单人脸库 样例 : 0	integer (int32)
pageNo 可选	当前页 样例 : 0	integer (int32)
pageSize 可选	每页数量 样例 : 0	integer (int32)
tagCodes 可选	标签列表 样例 : [ "string" ]	< string > array

添加更新人员对象

名称	说明	类型
address 可选	地址 样例 : "string"	string
birthday 可选	出生年月日（格式如2011-06-01） 样例 : "string"	string
bkgPicUrl 可选	背景图url 样例 : "string"	string
caseCode 可选	档案编号 样例 : "string"	string
certificateNumber 可选	证件号 样例 : "string"	string
certificateType 可选	证件类型（111-居民身份证，113-户口簿，114-中国人民解放军军官证，131-工作证，123警官证，133-学生证，335-机动车驾驶证，337-机动车行驶证，414-护照，782-市民卡，990-其他证件） 样例 : 0	integer (int32)
city 可选	城市 样例 : "string"	string
extFields 可选	扩展字段 样例 : [ "[f6807707367b70caa6ef25295d1e3769](#f6807707367b70caa6ef25295d1e3769)" ]	< 名单展示扩展字段 > array
facePicUrl 可选	人脸图片 样例 : "string"	string
gender 可选	注册性别（male-男， female-女，unknown-未知，最大长度为10，默认为unknown） 样例 : "string"	string
humanId 可选	人员id 样例 : "string"	string
libCode 可选	所属名单库ID（最大长度32） 样例 : "string"	string
managePolice 可选	责任民警 样例 : "string"	string
name 可选	姓名（最大长度32位，只支持中文或英文和.） 样例 : "string"	string
nation 可选	名族 样例 : "string"	string
nativeCountyCode 可选	籍贯编码 样例 : "string"	string
policePhone 可选	民警手机号 样例 : "string"	string
province 可选	省份编码 样例 : "string"	string
residenceCountyCode 可选	居住地编码 样例 : "string"	string
targetModelData 可选	样例 : "string"	string

点击确定时获取所有用户

名称	说明	类型
deptList 可选	样例 : [ "string" ]	< string > array
userList 可选	样例 : [ "[usersimplevo](#usersimplevo)" ]	< UserSimpleVo > array

用户

名称	说明	类型
userIndexCode 可选	用户编号 样例 : "string"	string
username 可选	用户名 样例 : "string"	string

车辆迁移

名称	说明	类型
libCode 可选	当前名单库编号 样例 : "string"	string
list 可选	迁移车辆列表，传入车牌颜色和车牌号即可 样例 : [ "[vehiclevo](#vehiclevo)" ]	< VehicleVO > array
targetLibCode 可选	迁移至名单库编号 样例 : "string"	string

部门

名称	说明	类型
deptIndexCode 可选	部门编号 样例 : "string"	string
existsChild 可选	该部门是否存在子部门 样例 : true	boolean
name 可选	部门名称 样例 : "string"	string

部门节点

一个部门节点包括这个部门的子部门和部门用户

名称	说明	类型
deptList 可选	子部门列表 样例 : [ "[1e1459eeed6da94506631a690c7efeab](#1e1459eeed6da94506631a690c7efeab)" ]	< 部门 > array
userList 可选	用户列表 样例 : [ "[1fd02a90c38333badc226309fea6fecb](#1fd02a90c38333badc226309fea6fecb)" ]	< 用户 > array