This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
流行病调查接口文档
说明
-
以下接口返回数据中只包含操作成功的数据，若操作失败出现异常（如接口参数有误）则返回数据格式如下：
{ "code": "状态码", "msg": "提示信息，如XXX参数有误" } -
后端返回给前端的数据中所有日期数据格式均为
yyyy-MM-dd HH:mm:ss
用户部分
1、登录
-
url：
/user/login -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "phone": "cveo", "password": "cveo123456" } -
返回数据
{ "code": 0, "msg": "请求成功！", "data": { "token": "8f6b21a0-fa4b-4241-b5f7-58355048e1f9", "username": "cveo", "idNumber": "", "phone": "cveo", "roleSet": [ { "name": "管理员", "authoritySet": [ "XXX权限" ] } ], "departmentList": [], "administrativeArea": { "province":"XXX", "city":"XXX", "county":"XXX" } } } Response code: 200; Time: 923ms; Content length: 224 bytes
2、修改用户角色
-
url：
/user/userRole -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "phone": "13995833300", "roleSet": [ "测试角色" ] } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": null }
3、查询用户列表
-
url：
/user/userList -
method：
GET -
参数列表
参数名 是否可选 参数类型 参数说明 username 是 String 用户名模糊查询 phone 是 String 电话号码精确查询 pageSize 是 int 页大小，默认为30 currentPage int 当前页数，从0开始 -
返回数据
{ "code": "状态码", "msg": "查询成功", "data": { "totalCount": "筛选后的总数", "currentPage": "当前页数", "pageSize": "页大小", "data": [ { "idNumber":"XXXXX", "username": "用户名", "phone": "电话号码", "roleSet": [ { "name":"XXX", "authoritySet":[ "XXX权限" ] } ], "departmentList": [ ], "administrativeArea": { "province":"XXX", "city":"XXX", "county":"XXX" } } ] } }
4、管理员删除用户
-
url：
/user/user -
method**：**
DELETE -
Content-Type：
application/json -
参数列表
{ "phone": "用户的电话号码" }" -
返回数据
{ "code": "状态码", "msg": "删除成功", "data": null }
5、管理员修改用户信息
-
url：
/user/user -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "phone": "13995833308", "username": "Pope8", "idNumber": "4207042000022700118", "administrativeArea": { "province": "湖北省", "city": "鄂州市", "county": "鄂城区" } } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": null }
6、管理员重置用户密码
-
url：
/user/pwd -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "phone": "用户电话号码" } -
返回数据
{ "code": "状态码", "msg": "重置成功", "data": null }
7、管理员创建用户
-
url：
/user/user -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "idNumber": "4207042000227001X", "username": "Pope10", "phone": "1399583330X", "password": "13995833308", "administrativeArea": { "province": "湖北省", "city": "鄂州市", "county": "鄂城区" } } -
返回数据
{ "code": "状态码", "msg": "创建成功", "data": null }
角色部分
1、添加角色
-
url：
/role/role -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "name": "新角色名", "authoritySet": [ //权限列表 "XXX权限", "XXXX权限" ] } -
返回数据
{ "code": "状态码", "msg": "创建成功", "data": null }
2、查询角色列表
-
url：
/role/roleList -
method：
GET -
参数列表：
参数名 是否可选 参数类型 参数说明 pageSize 是 int 页大小，默认30 currentPage int 当前页数，从0开始 name 是 String 权限名模糊匹配 -
返回数据
{ "code": "状态码", "msg": "查询成功", "data": { "pageSize": 30, "totalCount": 2, "currentPage": 0, "data": [ { "name": "流调人员", "authoritySet": [ "查询调查记录的权限", "修改调查记录权限", "分析调查记录权限", "增删改调查对象信息的权限", "提交调查记录权限", "删除调查记录权限", "查询流调人员信息的权限", "查询调查对象信息的权限" ] } ] } }
3、删除角色
-
url：
/role/role -
method：
DELETE -
Content-Type：
application/json -
参数列表：
{ "name": "XXX角色" } -
返回数据
{ "code": "状态码", "msg": "删除成功", "data": null }
4、修改角色权限列表
-
url：
/role/role -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "name": "XXX角色", "authoritySet": [ "XXX权限", "XX权限" ] } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": null }
5、查看所有权限列表
-
url：
/role/authorityList -
method：
GET -
Content-Type：
application/json -
参数列表：
无
-
返回数据
{ "code": "状态码", "msg": "查询成功", "data": [ "XXX权限", "XX权限", "XXXXX权限" ] }
调查对象部分
1、创建待调查对象
-
url：
/respondent/respondent -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "idNumber": "调查对象身份证号", "phone": "调查对象的手机号", "name": "调查对象姓名", "msg": "备注", "userPhone": "分配给的用户的电话号码", "gender": "男/女", "administrativeArea": { //调查对象的行政区划 "province": "XX省", "city": "XX市", "county": "XX区" }, "userPhone":"XXXX", "projectName":"XXXX" } -
返回数据
{ "code": "状态码", "msg": "创建成功", }
2、查询调查对象列表
-
url：
/respondent/respondentList -
method：
GET -
参数列表：
参数名 是否可选 参数类型 参数说明 userPhone 是 String 分配的用户的电话号码 projectName 是 String 项目名 state 是 String 已调查/待调查/已归档 idNumber 是 String 身份证号 name 是 String 姓名，模糊查询 phone 是 String 电话号码 province 是 String 行政区划省份 city 是 String 行政区划城市 county 是 String 行政区划区县 currentPage int 当前页数，从0开始 pageSize 是 int 当前页大小，默认为30 -
返回数据
{ "code": "状态码", "msg": "查询成功", "data": { "totalCount": "筛选后总数量", "currentPage": "当前页数", "pageSize": "页大小", "data":[ { "idNumber": "调查对象身份证号", "phone": "调查对象", "name": "调查对象姓名", "msg": "备注", "gender": "男/女", "administrativeArea": { //调查对象的行政区划 "province": "XX省", "city": "XX市", "county": "XX区" }, "userInfo": { //分配给的用户的信息 "idNumber": "身份证号", "username": "姓名", "phone": "电话号码" }, "projectName":"XXX", "state":"XXX" } ] } }
3、修改调查对象
-
url：
/respondent/respondent -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "idNumber": "调查对象身份证号", "phone": "调查对象的手机号", "name": "调查对象姓名", "msg": "备注", "userPhone": "分配给的用户的电话号码", "gender": "男/女", "administrativeArea": { //调查对象的行政区划 "province": "XX省", "city": "XX市", "county": "XX区" }, "projectName":"XXX" } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": null }
4、删除调查对象
-
url：
/respondent/respondent -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "idNumber": "XXXXXXX", "projectName":"XXXX" } -
返回数据
{ "code": "状态码", "msg": "删除成功", "data": null }
调查记录
1、查询调查记录列表
-
url：
/record/recordList -
method：
GET -
参数列表：
参数名 是否可选 参数类型 参数说明 userPhone 是 String 分配给的用户的电话号码 projectName 是 String 项目名 state 是 String 已审核/待审核/已删除/已归档 idNumber 是 String 调查对象的身份证号 version 是 String 调查记录版本 questionnaireNumber 是 String 调查记录问卷编号 currentPage int 当前页数，从0开始 pageSize 是 int 页大小，默认为30 说明
若不传state参数，则默认查询状态为
已审核与未审核的调查记录。 -
返回数据：
{ "code": "状态码", "msg": "查询成功", "data": { "idNumber": "调查对象身份证号", "userPhone": "分配的用户电话号码", "projectName":"XXX", "operationInfoList": [ { "type": "提交/修改/删除/恢复/审核", "date": "操作时间", "userPhone": "操作者电话号码", "version": "版本信息", "msg": "备注信息", "result": "操作结果" }, { "type": "提交/修改/删除/恢复/审核", "date": "操作时间", "userPhone": "操作者电话号码", "version": "版本信息", "msg": "备注信息", "result": "操作结果" } ], "version": "版本信息", "state": "已审核/待审核/已删除/已归档" } }
2、查询调查记录value字段
-
url：
/record/recordValues -
method：
GET -
参数列表
参数名 是否可选 参数类型 参数备注 idNumber String 身份证号 projectName String 项目名 version 是 String 版本 -
返回数据
{ "code":"XXX", "msg":"请求成功", "data":{ "XXX":"XXX", "XXX":"XXX" } }
3、查询待审核调查记录数量
-
url：
/record/underReviewRecordCount -
method：
GET -
参数列表：
参数名 是否可选 参数类型 参数说明 userPhone String 分配的用户的电话号码 -
返回数据
{ "code": "状态码", "msg": "查询成功", "data": 100 //数量 }
4、审核待审核调查记录
-
url：
/record/underReviewRecord -
method**：**
PUT -
Content-Type：
application/json -
参数列表：
{ "idNumber": "调查对象身份证号", "projectName": "项目名" "pass": "true/false", //审核是否通过 "msg": "审核信息", "reviewerPhone": "审核者电话号码" } -
返回数据
{ "code": "状态码", "msg": "审核成功", "data": null }
5、修改已审核调查记录
-
url：
/record/record -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "idNumber":"", "projectName":"", "values": { }, "userPhone": "执行修改操作的用户的电话号码", "msg": "备注"; } -
返回数据
{ "code": "状态码", "msg": "修改成功，等待审核", "data": null }
6、提交调查记录
-
url：
/record/record -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "idNumber": "调查对象身份证号", "userPhone": "分配的用户的电话号码", "projectName": "", "values": { ... }, "msg": "备注" } -
返回数据：
{ "code": "状态码", "msg": "提交成功", "data": null }
7、导出为Word
元数据
1、创建元数据
-
url：
/metadata/metadata -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "name": "XXX", "form": {}, "fieldToName": [ { "field": "", "name": "" } ], "config": {} } -
返回数据
{ "code": "状态码", "msg": "创建成功" "data": null }
2、删除元数据
-
url：
/metadata/metadata -
method：
DELETE -
Content-Type：
application/json -
参数列表：
{ "name": "XXX" } -
返回数据
{ "code": "状态码", "msg": "删除成功", "data": null }
3、修改元数据
-
url：
/metadata/metadata -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "name": "XXX", "form": {}, "fieldToName": [ { "field": "", "name": "" } ], "config": {} } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": null }
4、查询元数据列表
-
url：
/metadata/metadataList -
method：
GET -
参数列表：
{ "name": "XXX" } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": { "name": "XXX", "form": {}, "fieldToName": [ { "field": "", "name": "" } ], "wordTemplate": "", "config": {} } }
5、精确查询元数据
-
url：
/metadata/metadata -
method：
GET -
参数列表：
参数名 是否可选 参数类型 参数说明 name String 名字 -
返回数据
{ "code":"XXX", "msg":"XXX", "data":{ "name": "XXX", "form": {}, "fieldToName": [ { "field": "", "name": "" } ], "wordTemplate": "", "config": {} } }
项目
1、创建项目
-
url：
/project/project -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "name":"XXX", "detail":"XXX", "metaDataName":"XXX", "startTime":"yyyy-MM-dd HH:mm:ss", "endTime":"yyyy-MM-dd HH:mm:ss", "userPhone":"" } -
返回数据
{ "code": "状态码", "msg": "删除成功", "data": null }
2、查询项目列表
-
url：
/project/projectList -
method：
GET -
参数列表：
参数名 是否可选 参数类型 参数说明 name 是 String 名字 currentPage int 当前页数 pageSize 是 int 页大小 -
返回数据
{ "code": "状态码", "msg": "查询成功", "data": { "totalCount": "筛选后总数量", "currentPage": "当前页数", "pageSize": "页大小", "data":[ { "name":"XXX", "detail":"XXX", "metaDataName":"XXX", "startTime":"yyyy-MM-dd HH:mm:ss", "endTime":"yyyy-MM-dd HH:mm:ss", "state":"XXX" } ] } }
3、查询待调查对象数与调查对象总数
-
url：
/project/respondentCount -
method：
POST -
Content-Type：
application/json -
参数列表：
{ "name":"XXX" } -
返回数据
{ "code":"XXX", "msg":"XXX", "data":{ "respondentCount":"总数", "notInvestigatedRespondentCount":"待调查对象数量" } }
4、修改项目状态
-
url：
/project/projectState -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "name":"XXX", "state":"XXX" } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": null }
5、修改调查对象信息
-
url：
/project/project -
method：
PUT -
Content-Type：
application/json -
参数列表：
{ "name":"XXX", "detail":"XXX", "startTime":"yyyy-MM-dd HH:mm:ss", "endTime":"yyyy-MM-dd HH:mm:ss", "userPhone":"" } -
返回数据
{ "code": "状态码", "msg": "修改成功", "data": null }