帝麦克斯后台接口文档v15.docx
- 文档编号:14407739
- 上传时间:2023-06-23
- 格式:DOCX
- 页数:42
- 大小:27.14KB
帝麦克斯后台接口文档v15.docx
《帝麦克斯后台接口文档v15.docx》由会员分享,可在线阅读,更多相关《帝麦克斯后台接口文档v15.docx(42页珍藏版)》请在冰点文库上搜索。
帝麦克斯后台接口文档v15
后台接口文档V1.5
一接口规则
接口约定
约定
备注说明
1.服务器返回的所有数据均采用JSON格式。
1.对象采用{}界定;数组采用[]界定;
2.所有字段命名采用小写字母开始的小驼峰命名法。
如:
getUserInfo、createUserInfo
包括客户端向服务器提交的字段名,和服务器返回的JSON结构中的字段名
3.所有接口返回的JSON结构中,都有三个共同的字段resultCode,resultMsg,data。
resultCode:
表示结果码;
0-表示请求成功;
非0-表示出现错误或异常
resultMsg:
状态消息,跟resultCode对应
data:
返回消息详情内容;
移动客户端与服务器通信原理
采用短连接的http协议进行通讯,提交方式为POST与GET相结合的方式,返回数据格式为JSON。
公共头信息
所有接口的请求,均需包含如下公共头信息:
参数名称
参数类型
是否可以为空
说明
token
字符串
否(登录时为空)
用户登录时候为空,合法性校验,用户ID+时间戳生成
device
字符串
是
请求终端类别(安卓、苹果、微信、网页等)
所有接口的响应,均需包含如下公共头信息:
参数名称
参数类型
是否可以为空
说明
resultCode
字符串
否
resultCode:
表示结果码;
0-表示请求成功;
非0-表示出现错误或异常,如果有错误将会在resultMsg中显示
resultMsg
字符串
否
状态消息,跟resultCode对应
token
字符串
否
最新的token信息
二系统管理员
上传资源
接口地址(URL)
Ip:
port/common/upload
提交方式
POST
参数名称
是否必须
描述
样例
token
否
file
是
字节流
fileType
是
.jpg,.png
返回字段说明
资源ID
请求示例
返回示例
{
"resultCode":
"0",
"resultMsg":
"",
"data":
{
“resId”:
”10”
}
}
登录
接口地址(URL)
Ip:
port/user/login/
提交方式
POST
参数名称
是否必须
描述
样例
account
是
“account”:
”test”
pwd
是
用来标识用户身份的一个id字串
“pwd”:
”123456”
Code
否
验证码
返回字段说明
name登录人姓名
token
请求示例
{
"userId":
"test",
"pwd":
"123456"
}
返回示例
{
"resultCode":
"0",
"resultMsg":
"",
"data":
{
"token":
"E10ADC3949BA59ABBE56E057F20F883E",
"name":
"张三",
roleId:
1
}
}
退出
接口地址(URL)
Ip:
port/user/loginOut
提交方式
POST
参数名称
是否必须
描述
样例
token
是
用户合法校验码
"token":
"E10ADC3949BA59ABBE56E057F20F883E"
返回字段说明
“resultCode”
“resultMsg”
请求示例
{“token”:
”10ADC3949BA59ABBE56E057F20F883E”}
返回示例
“resultCode”:
“0”,“resultMsg”:
””
修改密码
超级管理员修改自己的密码,管理其他用户的时候是恢复初始密码
客户端密码也采用RSA加密方式
接口地址(URL)
Ip:
port/user/editPwd/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
oldPwd
是
原密码
newPwd
是
新密码
返回字段说明
请求示例
{“token”:
”E10ADC3949BA59ABBE56E057F20F883E”,”oldPwd”:
”123456”,”newPwd”:
”abcdef”}
返回示例
权限分配
接口地址(URL)
Ip:
port/manage/privilege/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
account
是
memu
是
菜单配置json嵌套json
{"id1":
"true","id2":
"true","id3":
"false","id4":
"true"}
返回字段说明
请求示例
{“token”:
”E10ADC3949BA59ABBE56E057F20F883E“,”menu”:
{"id1":
"true","id2":
"true","id3":
"false","id4":
"true"}}
返回示例
三申请端
申请端用户查询
接口地址(URL)
Ip:
port/info/selectUserList/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
pageIndex
页码
pageSize
页大小
type
是
0:
申请端
1:
审核员
返回字段说明
“data”:
[]包含符合条件的医院列表
“hospital”医院名称
“pwd”密码
“contacts”联系人
“phone”联系电话
“userId”帐号
“speciality”专长
“sex”性别
请求示例
{“token”:
”E10ADC3949BA59ABBE56E057F20F883E”,“pageIndex”:
”1”,”pageSize”:
”10”,”type”:
”1”}
返回示例
{
"resultCode":
"0",
"resultMsg":
"",
"pageIndex":
"2",
"data":
[
{
"hospital":
"苏州第一医院",
"pwd":
"123456",
"contact":
"李博士",
"phone":
"18*********",
"userId":
"test1",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"pwd":
"123456",
"contact":
"张博士",
"phone":
"18*********",
"userId":
"test2",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"pwd":
"123456",
"contact":
"赵博士",
"phone":
"18*********",
"userId":
"test3",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"pwd":
"123456",
"contact":
"钱博士",
"phone":
"18*********",
"userId":
"test4",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"pwd":
"123456",
"contact":
"孙博士",
"phone":
"18*********",
"userId":
"test5",
"speciality":
"内科"
}
]
}
新建/更新申请端帐号
接口地址(URL)
Ip:
port/manage/upsertApplyUser/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
id
account
是
登录帐号
name
是
联系人
phone
是
联系手机
hos_id
是
所属医院
返回字段说明
请求示例
{
"token":
"E10ADC3949BA59ABBE56E057F20F883E",
"account":
"test",
"contact":
"李院长",
"phone":
"180********",
"hospitalId":
1,
}
返回示例
成功:
{"resultCode":
"0","resultMsg":
"",data:
userId}
失败:
{"resultCode":
"-1","resultMsg":
"当前用户已经注册!
"}
检测登录帐号是否存在
接口地址(URL)
Ip:
port/common/ifAccountExists/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
”
account
是
返回字段说明
“exists”:
”0”还没注册
“exists”:
’-1”已经注册
请求示例
{
"token":
"E10ADC3949BA59ABBE56E057F20F883E",
"userId":
"test"
}
返回示例
还没注册:
{
"resultCode":
"0",
"resultMsg":
"",
"exists":
"0"
}
已经注册:
{
"resultCode":
"0",
"resultMsg":
"",
"exists":
"-1"
}
医院查询
接口地址(URL)
Ip:
port/info/selectHospitalList/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
province
否
省
city
否
市
area
否
区(预留)
pageIndex
否
当前页码默认值0
pageSize
否
每页条数默认10
返回字段说明
返回token不断刷新token
“data”:
[]包含符合条件的医院列表
“hospital”医院名称
“diagnose”诊断
“cost”费用
“speciality”专长
请求示例
{
"token":
"827CCB0EEA8A706C4C34A16891F84E7B",
"province":
"江苏省",
"city":
"苏州市",
"pageIndex":
"3",
"pageSize":
"20"
}
返回示例
"resultCode":
"0","resultMsg":
"",
"data":
[
{
"hospital":
"苏州第一医院",
"diagnose":
"",
"cost":
"2000",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"diagnose":
"",
"cost":
"2000",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"diagnose":
"",
"cost":
"2000",
"speciality":
"内科"
}
]
专家查询
接口地址(URL)
Ip:
port/info/selectExpertsList/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
province
是
省
city
是
市
hospital
是
所属医院
pageIndex
否
当前页码默认值0
pageSize
否
每页条数默认10
返回字段说明
data[]返回专家数组
“name”专家名字
“cost”诊断费用
“hospital”所属医院
“speciality”专长
请求示例
{
"token":
"827CCB0EEA8A706C4C34A16891F84E7B",
"province":
"江苏省",
"city":
"苏州市",
"pageIndex":
"3",
"pageSize":
"20"
}
返回示例
"resultCode":
"0","resultMsg":
"",
"data":
[
{
"hospital":
"苏州第一医院",
"name":
"李瑶",
"cost":
"2000",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"name":
"李瑶",
"cost":
"2000",
"speciality":
"内科"
},
{
"hospital":
"苏州第一医院",
"name":
"李瑶",
"cost":
"2000",
"speciality":
"内科"
}
]
恢复初始密码
接口地址(URL)
Ip:
port/manage/resetPwd/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
userId
是
返回字段说明
请求示例
{
"token":
"827CCB0EEA8A706C4C34A16891F84E7B",
"userId":
"test"
}
返回示例
成功:
{"resultCode":
"0","resultMsg":
""}
失败:
{"resultCode":
"-1","resultMsg":
"密码修改失败!
"}
删除帐号
把该用户的enabled帐号启用标志置为0
接口地址(URL)
Ip:
port/manage/enableUser/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
id
是
enabled
是
返回字段说明
请求示例
{
"token":
"827CCB0EEA8A706C4C34A16891F84E7B",
"userId":
"test"
}
返回示例
成功:
{"resultCode":
"0","resultMsg":
""}
失败:
{"resultCode":
"-1","resultMsg":
"用户删除失败!
"}
编辑帐号
参考新建帐号
四审核员
审核员用户查询
参考申请端用户查询
新建(编辑)审核员帐号
接口地址(URL)
Ip:
port/manage/upsertAuditorUser/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
account
是
登录帐号
contact
是
联系人
phone
是
联系手机
hospitalId
是
审核医院
返回字段说明
请求示例
{
"token":
"E10ADC3949BA59ABBE56E057F20F883E",
"account":
"test",
"contact":
"李院长",
"phone":
"180********",
"hospitalId":
1,
}
返回示例
成功:
{"resultCode":
"0","resultMsg":
""}
失败:
{"resultCode":
"-1","resultMsg":
"当前用户已经注册!
"}
检测登录帐号是否存在
参考申请端检测
医院筛选
参考申请端
删除帐号
参考申请端
编辑帐号
同新建
五专家
专家查询
接口地址(URL)
Ip:
port/info/selectExpertsList/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
pageIndex
页码
pageSize
页大小
返回字段说明
姓名
性别
帐号
密码
联系电话
医院名称
专长
请求示例
{“token”:
”E10ADC3949BA59ABBE56E057F20F883E”,“pageIndex”:
”1”,”pageSize”:
”10”}
返回示例
{
"resultCode":
"0",
"resultMsg":
"",
"pageIndex":
"2",
"data":
[
{
"hospital":
"苏州第一医院",
"pwd":
"123456",
"contact":
"李博士",
"phone":
"18*********",
"userId":
"test1",
"speciality":
[“”,””]
}
]
}
新建/更新专家
接口地址(URL)
Ip:
port/manage/upsertExpertsUser/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
account
是
登录帐号
name
是
姓名
phone
是
联系手机
hospitalId
是
所属医院
sex
是
性别
0男
1女
cost
是
诊断费用
headImgId
头像图片
specialty
专长的json:
[专长id,专长id]
Memo
简介
weixin
否
返回字段说明
请求示例
{
"token":
"E10ADC3949BA59ABBE56E057F20F883E",
"userId":
"test",
"name":
"李博士",
"phone":
"180********",
"hospital":
"苏州第一医院",
"sex":
"0",
"cost":
"200",
"headImg":
"",
"weixin":
""
"specialty":
{"sp1":
"true","sp2":
"true","sp3":
"true"}
}
返回示例
成功:
{"resultCode":
"0","resultMsg":
""}
失败:
{"resultCode":
"-1","resultMsg":
"当前用户已经注册!
"}
检测专家是否存在
参考申请端
专长显示
从专长数据表中返回系统目前已经有的专长信息
查看专家详情
接口地址(URL)
Ip:
port/info/getExpertsInfo/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
“userId”:
”test”
userId
是
专家ID
返回字段说明
“userId”帐号
“sex”性别
“hospital”所属医院
“cost”诊断费用
speciality专长json
“weixin”微信号
“phone”联系电话
“title”教学职称
“memo”描述
请求示例
{
"token":
"827CCB0EEA8A706C4C34A16891F84E7B",
"userId":
"test"
}
返回示例
{
"userId":
"test",
"sex":
"0",
"hospital":
"苏州医院",
"cost":
"200",
"speciality":
{
"sp1":
"true",
"sp2":
"true",
"sp3":
"true"
},
"weixin":
"liboshi",
"phone":
"138********",
"title":
"博士",
"memo":
"内科专家,资深研究经验"
}
恢复初始密码
同申请端
删除帐号
同申请端
编辑帐号
同新建专家
六短信
编辑短信模版
接口地址(URL)
Ip:
port/manage/updateMessageTemp/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
短信模版id
是
模版内容
是
短信内容
返回字段说明
返回示例
短信通知
接口地址(URL)
Ip:
port/manage/sendMessage/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
userList[]
是
用户手机集合、姓名集合
message
是
短信内容(从页面传入后台不再从数据表读取)
返回字段说明
请求示例
{
"token":
"",
"message":
"您有新的会诊,请注意查看.",
"userList":
[
{
"name":
"张三",
"phone":
"138********"
},
{
"name":
"张三",
"phone":
"138********"
},
{
"name":
"张三",
"phone":
"138********"
},
{
"name":
"张三",
"phone":
"138********"
}
]
}
返回示例
七数据统计
数据统计查询
八医科数据维护
添加
接口地址(URL)
Ip:
port/manage/addMedical/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
parentID
否
name
是
专长名称
返回字段说明
删除
只有在没有子内容的情况下才可以被删除
接口地址(URL)
Ip:
port/manage/deleteMedical/
提交方式
POST
参数名称
是否必须
描述
样例
token
是
专长id
是
返回字段说明
请求示例
{“token”:
”E10ADC3949BA59ABBE56E057
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 麦克 后台 接口 文档 v15