点点兼职微服务接口API(api)
Note:该文档采用Markdown语法编辑,已发布到简书,可访问https://www.jianshu.com/p/9d331bef9ac9
一、接口定义规范
1.1URI命名规范
在定义URI接口时,需要遵循以下原则:
* URI路径全部采用小写;
* URI路径中不要出现“_”,必要的分隔符建议采用“-”;
* URI中的斜杠“/”仅表示资源见的分隔关系;
* URI接口采用HTTP方法表示动作行为;
* URI的定义格式如下:
URI = http://网址[:端口]/{业务域}/{接口集合}/接口名。
1.2接口数据交互规范
* 接口请求格式采用JSON数据格式,参数内容以具体接口的要求为准;
* 接口响应采用统一的JSON格式,其格式要求如下:
{
"status": 200,
"message":"操作成功",
"total":1,
"data": {
"id":"123",
"name": "lilei",
"age": 18
}
}
* 接口返回结果应该包含状态码,状态码含义参考HTTP1.1协议状态码,本系统采用的部分状态码如下:
- 101:用户没有登录;
- 102:用户被踢出;
- 200:操作成功;
- 202:已接受,已经接受请求,但未处理完成;
- 204:无内容,服务器成功处理,但未返回内容;
- 400:客户端请求的语法错误,服务器无法理解;
- 404:查询无数据;
- 500:系统报错;
二、地推员信息接口集合(promoter)
2.1地推员手机号登录请求接口
2.1.1接口说明
根据地推员手机号执行地推员登录请求功能,在地推员信息验证通过的情况同步完成验证码发送,返回地推员登录响应DTO。
2.1.2接口地址
http://IP:Port/api/promoter/login
2.1.3访问方式
get
2.1.4参数说明
参数为json数据,请求要求Context-type:application/json
{"tel":"15054177092"}
tel:地推员的手机号。
2.1.5返回结果
反馈结果示例如下:
{
"status": 200,
"message":"操作成功",
"total":1,
"data": {
"promoterId":1,
"tenantId":3,
"name":"点点地推员",
"cardCode":"AABBCCDD",
"loginname":"dituiyuan1",
"tel":"15054177092",
"captchaStatus":1
}
}
状态码如下:
200:操作成功
202:[账户未启用,账户被锁定,非地推员,验证码发送失败]
400:[手机号非法,参数缺失]
404:查询无数据
500:系统报错
数据项说明:
promoterId:地推员id
tenantId:地推员所属加盟商id
name:地推员姓名
cardCode:地推员卡号
loginname:地推员登录名
tel:地推员电话,
captchaStatus:验证码发送状态,1为验证码发送成功,-1为验证发送失败
2.2地推员在岗状态查询
2.2.1接口说明
根据地推员手机号查询该地推员的在岗状态和在岗地址
2.2.2接口地址
http://IP:Port/api/promoter/attendance
2.2.3访问方式:
get
2.2.4参数说明:
参数为json数据,请求要求Context-type:application/json
{"tel":"15054177092"}
tel:地推员的手机号。
2.2.5返回结果
反馈结果示例如下:
{
"status": 200,
"message":"操作成功",
"total":1,
"data": {
"promoterId":1,
"institutionId":1,
"institutionName":"祥泰新河湾",
"machineId":1,
"machineName":"10号楼",
"workDate":"2019-02-27",
"startTime":"2019-02-27 08:23:02",
"endTime":"2019-02-27 18:02:33",
"workPlace":"祥泰新河湾,10号楼",
"attendanceStatus":1
}
}
状态码如下:
200:操作成功
202:[账户未启用,账户被锁定,非地推员]
400:[参数缺失,手机号非法]
404:查询无数据
500:系统报错
数据项说明:
promoterId:地推员id
instituitionId:当前地推员上岗小区Id
institutionName:地推员上岗小区
machineId:回收机Id
machineName:回收机名称
workDate:工作日期
startTime:到岗时间
endTime:离岗时间
workPlace:工作地点
attendanceStatus:到岗状态,0:未到岗,1:在岗,-1:离岗
2.3地推员信息获取接口
2.3.1接口说明
根据地推员手机号获取地推员信息
2.3.2接口地址
http://IP:Port/api/promoter/promoter
2.3.3访问方式
get
2.3.4参数说明
参数为json数据,请求要求Context-type:application/json
{"tel":"15054177092"}
tel:地推员的手机号。
2.3.5返回结果
反馈结果示例如下:
{
"status": 200,
"message":"操作成功",
"total":1,
"data": {
"promoterId":1,
"tenantId":3,
"name":"点点地推员",
"cardCode":"AABBCCDD",
"loginname":"dituiyuan1",
"tel":"15054177092",
"isPromoter":true
}
}
状态码如下:
200:操作成功
202:[账户未启用,账户被锁定,加盟商不存在,非地推员]
400:[参数缺失,手机号非法]
404:查询无数据
500:系统报错
数据项说明:
promoterId:地推员id
tenantId:地推员所属加盟商id
name:地推员姓名
cardCode:地推员卡号
loginname:地推员登录名
tel:地推员电话,
isPromoter:是否为地推员,true为地推员,反之为false
三、用户信息接口集合(userinfo)
3.1用户信息查询
3.1.1接口说明
根据用户的手机号、姓名、用户Id查询用户信息,针对姓名采用模糊查询,对手机号和Id进行等值查询,
该接口仅查询当前地推员所属加盟商下的用户
3.1.2接口地址
http://IP:Port/api/userinfo/getUserinfos
3.1.3访问方式:
get
3.1.4参数说明
参数为json数据,请求要求Context-type:application/json
{"telOrName":"15054177092","userId":1345,"promoterId":1}
telOrName:用户手机号或姓名;
userId:用户Id
promoterId:地推员Id。
3.1.5返回结果
{
"status": 200,
"message":"操作成功",
"total":1,
"data": [{
"userId":1,
"userName":"张三",
"nickName":"张三昵称",
"faceImage":"images/resource/1.jpg",
"institutionId":1,
"institutionName":"祥泰新河湾",
"tel":"1505477092",
"balance":550.00,
"totalBalance":1000.00,
"points":30,
"totalPoints":300,
"status":1,
"firstFlag":1,
"demoFlag":2,
"canceled":1,
"createTime":"2019-03-18 12:11:12",
"wechatCode":"obtao0lkLJ5jJ4gHMCKH8_og_rqA",
"wechatOffical":"diandian"
"cards":[{"cardCode":"AS1502","qcCode":"0531001002"},{"cardCode":"AS1503","qcCode":"0531001003"},]
},{
"userId":1,
"userName":"李四",
"nickName":"李四昵称",
"faceImage":"images/resource/2.jpg",
"institutionId":1,
"institutionName":"祥泰新河湾",
"tel":"1505477093",
"balance":550.00,
"totalBalance":1000.00,
"points":30,
"totalPoints":300,
"status":1,
"firstFlag":1,
"demoFlag":2,
"canceled":1,
"createTime":"2019-03-18 12:11:12",
"wechatCode":"obtao0lkLJ5jJ4gHMCKH8_og_rqA",
"wechatOffical":"quxiang",
"cards":[{"cardCode":"AS1504","qcCode":"0531001004"},{"cardCode":"AS1504","qcCode":"0531001004"},]
}]
}
状态码如下:
200:操作成功
400:[包含非法字符]
404:查询无数据
500:系统报错
数据项说明:
userId:用户id
userName:用户名
nickName:用户昵称
faceImage:头像
institutionId:用户所在小区Id
institutionName:用户所在小区名称
tel:电话
balance:账户余额
totalBalance:累计金额
points:积分
totalPoints:累计积分
firstFlag:是否首次投放,1:首次投放,2:非首次投放
demoFlag:是否演示用户,0:正常用户,1:演示用户
wechatCode:用户微信openId
wechatOffical:用户关注的微信公众号
cards:用户卡号列表,cardCode为卡芯片号,qcCode为卡印刷号
status:用户状态,1:启用,2:停用
canceled:是否销户,无卡并且不是微信用户即为销户状态。1:销户,2:未销户。
只要wechatCode不为空或者cards不为空则,当前用户即为未销户
createTime:用户创建时间
3.2用户绑卡
3.2.1接口说明
根据用户id和卡号执行绑卡操作
3.2.2接口地址
http://IP:Port/api/userinfo/bindCard
3.2.3访问方式
post
3.2.4参数说明:
{"userId":"1","cardCode":"AABBCCDD","promoterId":1}
userId:用户id;
cardcode:卡号;
promoterId:地推员Id。
3.2.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 202,
"message":"卡被占用",
"total":1,
"data": null
}
状态码如下:
200:操作成功
202:[卡被占用,用户停用,地推员权限不足]
400:[卡号非法,数据非法]
500:系统报错
数据项说明:
无参数项
3.3用户销卡
3.3.1接口说明
根据用户id,卡号执行用户销卡操作
3.3.2
http://IP:Port/api/userinfo/discard
3.3.3访问方式
post
3.3.4参数说明:
{"userId":"1","cardCode":"AABBCCDD","promoterId":1}
userId:用户id;
cardCode:卡号;
promoterId:地推员Id。
3.3.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": ""
}
状态码如下:
200:操作成功
202:[用户不存在,卡和用户不匹配,地推员权限不足,卡号非法]
400:[参数缺失]
500:系统报错
数据项说明:
无参数项
3.4用户销户
3.4.1接口说明
根据用户id,执行销户操作,在销户过程中,把该账户对应的所有卡进行解绑,用户与卡的对应关系删除,卡库信息恢复未发放。
3.4.2接口地址
http://IP:Port/api/userinfo/discardUser
3.4.3访问方式
post
3.4.4参数说明:
{"userId":"1","promoterId":1}
userId:用户Id;
promoterId:地推员Id
3.4.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": ""
}
状态码如下:
200:操作成功
202:[用户不存在,用户已停用,地推员权限不足]
400:[参数缺失]
500:系统报错
数据项说明:
无参数项
3.5用户创建
3.5.1接口说明
根据用户id,执行用户创建操作
3.5.2接口地址
http://IP:Port/api/userinfo/addUser
3.5.3访问方式:
post
3.5.4参数说明:
{"userName":"张三","promoterId":"1","tel":"15054177092","institutionId":1,"cardCode":"AABBCCDD"}
userName:用户名
promoterId:地推员id
tel:用户手机号
institutionId:机构id
cardCode:卡号
3.5.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": ""
}
状态码如下:
200:操作成功
202:[手机号被占用,卡号不占用]
400:[手机号非法,卡号非法,用户名包含特殊字符,机构不存在,机构未启用]
500:系统报错
数据项说明:
无参数项
3.6更改用户手机号
3.6.1接口说明
更改用户手机号
3.6.2接口地址
http://IP:Port/api/userinfo/updateTel
3.6.3访问方式
post
3.6.4参数说明:
{"userId":"1","promoterId":1,"oldTel":"15054177093","tel":"15054177092"}
userId:用户id;
promoterId:地推员Id
oldTel:旧手机号
tel:新手机号
3.6.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": ""
}
状态码如下:
200:操作成功
202:[旧手机号不存在,旧手机号与用户不匹配,新手机号被占用,地推员权限不足]
400:[参数缺失]
500:系统报错
数据项说明:
无参数项
3.7用户卡信息查询
3.7.1接口说明
提供查询指定用户指定卡的信息功能。
3.7.2接口地址
http://IP:Port/api/userinfo/getUserCardInfos
3.7.3访问方式
get
3.7.4参数说明:
{"userId":"1","cardCode":"AABBCCDD"}
userId:用户id;
cardCode:用户卡芯片号
3.7.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": [{"userId":1,
"cardCode":"AABBCCDD",
"cardNumber":"NO.05310111979",
"operater":"张杰",
"bindDatetime":"2019-03-18 11:00:00"
}]
}
状态码如下:
200:操作成功
202:[用户与卡不对应,卡号不存在,用户不存在]
400:[参数缺失]
500:系统报错
数据项说明:
userId:用户id
cardCode:用户卡芯片号
cardNumber:用户卡印刷号
operater:绑卡操作员
bindDatetime:绑卡时间
四、用户业务信息(usertrade)
4.1用户交易记录查询
4.1.1接口说明
查询指定用户在时间范围内的交易记录
4.1.2接口地址
http://127.0.0.1:8080/api/usertrade/getUserTrades
4.1.3访问方式
get
4.1.4参数说明
{"userId":"1","startDate":"2019-02-01","endDate":"2019-02-02","tradeType":"1"}
userId:用户id
startDate:查询开始日期
endDate:查询结束日期
tradeType:交易类型,类型定义如下:0:全部,1:投放,-1:取现,2:办卡,-2:销卡。
4.1.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":3,
"data": [
{
"tradeDatetime":"2019-02-01 09:33:35",
"tradeType":1,
"tradePoint":50,
"tradeBalance":50.00,
"tradeStatus":1,
"recycleId":10345,
"recycleStatus":2,
"withdrawsId":0,
"cardCode":""
},
{"tradeDatetime":"2019-02-01 09:33:39",
"tradeType":-1,
"tradePoint":-50,
"tradeBalance":-50.00,
"tradeStatus":1,
"recycleId":0,
"recycleStatus":0,
"withdrawsId":1200,
"cardCode":""
},
{
"tradeDatetime":"2019-02-01 09:43:35",
"tradeType":-2,
"tradePoint":0,
"tradeBalance":0.00,
"tradeStatus":1,
"recycleId":10346,
"recycleStatus":0,
"withdrawsId":0,
"cardCode":"A0000002"
}
]
}
状态码如下:
200:操作成功
202:[交易类型非法,用户不存在,开始时间非法,结束时间非法]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
tradeDatetime:交易时间
tradeType:交易类型,1:投放,-1:取现,2:办卡,-2:销卡
tradePoint:交易积分
tradeBalance:交易金额
trandeStatus:交易状态,0:进行中,1:完成
recycleId:投放记录Id,只有在tradeType为1的情况下,才返回该字段,反之该字段为0
recycleStatus:回收状态,
在tradeType不为1的情况下,默认为0,代表当前交易无回收状态.
在tradetype为1的情况下,1:待回收,2:待分拣,3:待结算,4:已结算
withdrawsId:取现记录Id,在tradeType为-1的情况下有值,反之为0.
4.2用户投放详情查询
4.2.1接口说明
查询指定用户的投放详情
4.2.2接口地址
http://127.0.0.1:8080/api/usertrade/getUserRecycleDetail
4.2.3访问方式
get
4.2.4参数说明
{"recycleId":"10245"}
recycleId:用户投放记录Id。
4.2.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": [
{
"putDatetime":"2019-02-01 09:33:35",
"sortDatetime":"2019-02-02 08:23:34"
"settleDatetime":"2019-02-03 18:23:34"
"resourceName":"废纸壳",
"resourcePoint":0.5,
"weightWeight":5.00,
"actualWeight":5.00,
"weightMoney":2.5,
"actionMoney":2.5,
"barCode":"1561651515615156161151",
"sortWorker":"孙大海",
"recycleStatus":2,
"remark":"有色塑料暂不回收",
"sortImages":"1.jpg,2.jpg"
}
]
}
状态码如下:
200:操作成功
404:查询无数据
500:系统报错
数据项说明:
putDatetime:投放时间
sortDatetime:分拣时间
settleDatetime:结算时间
resourceName:废品品类名称
resourcePoint:单价
weightWeight:称重重量
actualWeight:实际重量
weightMoney:称重金额
actualMoney:实际金额
barCode:条码
sortWorker:分拣员
recycleStatus:回收状态,1:待回收,2:待分拣,3:待结算,4:已结算
sortImages:分拣图片,以逗号分隔的字符串
4.3用户取现
4.3.1接口说明
执行线下取现操作
4.3.2接口地址
http://IP:Port/api/usertrade/cashByPromoter
4.3.3访问方式
post
4.3.4参数说明
{"userId":"1","promoterId":"1","institutionId":1,"cashMoney":"50"}
userId:用户id
promoterId:地推员id
institutionId:机构id
cashMoney:取现金额
4.3.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": {
"userId":1,
"preCashMoney":"200.00",
"cashMoney":"50",
"aftCashMoney":"150",
"tradeDatetime":"2019-02-01 14:00:00"
}
}
状态码如下:
200:操作成功
202:[余额不足,取现金额非法,地推员权限不足]
400:[缺少参数]
404:查询无数据
500:系统报错
数据项说明:
userId:用户id
preCashMoney:提现前金额
cashMoney:提现金额
aftCashMoney:提现后金额
tradeDatetime:提现时间
4.4用户取现详情查询
4.4.1接口说明
查询指定取现详情
4.4.2接口地址
http://127.0.0.1:8080/api/usertrade/getUserCashDetail
4.4.3访问方式
get
4.4.4参数说明
{"withdrawsId":"1200"}
withdrawsId:用户取现记录Id。
4.4.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": [
{
"userId":1345,
"flowNum":"1561651515615156161151",
"cashDatetime":"2019-02-02 08:23:34",
"cashMoney":50.00,
"opWorker":"地推员",
"cashAddress":"祥泰新河湾",
"operatorType":2,
"cashType":3
}
]
}
状态码如下:
200:操作成功
404:查询无数据
500:系统报错
数据项说明:
userId:用户id;
flowNum:流水号;
cashDatetime:取现时间
cashMoney:取现金额
opWorker:操作员
cashAddress:取现地址
operatorType:操作人类型,1:用户自己,2:员工
cashType:取现类型,1: 微信取现,3:提取现金
4.5用户登录详情查询
4.5.1接口说明
查询指定小区、指定时长内用户的登录信息
4.5.2接口地址
http://127.0.0.1:8080/api/usertrade/getUserLogins
4.5.3访问方式
get
4.5.4参数说明
{"institutionId":1,"loginType":1,timediff:30}
institutionId:机构Id;
loginType:登录类型,1:卡登录 ,2:微信登录
timediff:时间范围单位分钟
4.5.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": [
{
"userId":1345,
"userName":"张安",
"tel":"15054177090",
"institutionName":"花园小区",
"status":1,
"loginTime":"2019-02-12 12:00:00",
"balance":50.00,
"wechatCode":"obtao0vwYmZmW0Vzpsvkcz0-NzkU"
},
{
"userId":1346,
"userName":"张一",
"tel":"15054177093",
"institutionName":"花园小区",
"status":2,
"loginTime":"2019-02-12 12:30:00",
"balance":50.00,
"wechatCode":"obtao0vwYmZmW0Vzpsvkcz0-NzkU"
}
]
}
状态码如下:
200:操作成功
202:[参数非法]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
userId:用户id;
userName:用户名;
institutionName:用户所在小区
status:用户状态,1:启用,2:停用
loginTime:登录时间
balance:余额
wechatCode:用户的微信openId
五、消息交互接口(message)
5.1短信验证码发送
5.1.1接口说明
发送短信验证码
5.1.2接口地址
http://IP:Port/api/message/sendCaptchaSms
5.1.3访问方式
post
5.1.4参数说明
{"tel":"15054177092","captchaType":1}
tel:发送验证码手机;
captchaType:验证码类型,1:用户注册,3:用户更改手机号,-1:用户销卡,-2:用户销户,5:系统用户登录
5.1.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": ""
}
状态码如下:
200:操作成功
202:[用户不存在,手机号非法,手机号与用户不匹配,验证码类型不存在]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
5.2验证码验证
5.2.1接口说明
验证码验证
5.2.2接口地址
http://IP:Port/api/message/checkCaptcha
5.2.3访问方式
get
5.2.4参数说明
{"tel":"15054177092","captcha":"8542","captchaType":1}
userId:用户id
tel:发送验证码手机
captchaType:验证码类型,1:用户注册,2:用户更改手机号,3:用户销卡,4:用户销户,5:系统用户登录
5.2.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": ""
}
状态码如下:
200:操作成功
202:[验证失败,用户不存在,手机号非法,验证码超时]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
无
5.3地推现场取现短信消息提醒
5.3.1接口说明
实现向手机发送地推现场取现短信消息
5.3.2接口地址
http://IP:Port/api/message/sendPromotCashSms
5.3.3访问方式
post
5.3.4参数说明
{"tel":"15054177092","time":"2019-03-14 10:53:20","type":"1","money":"20"}
tel:手机号码
time:提现时间
type:提现方式(1地推现场)
money:提现金额
5.3.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": ""
}
状态码如下:
200:发送成功
202:[用户不存在]
400:[手机号非法]
500:发送失败
数据项说明:
无
六、地推员业务接口(promoterwork)
6.1按月统计工作量
6.1.1接口说明
查询指定地推员id的月统计数据
6.1.2接口地址
http://IP:Port/api/promoterwork/findWorkInfoByTypeAndDate
6.1.3访问方式
get
6.1.4参数说明
{"promoter":"1","workType":"1","startDate":"2019-02-01","endDate":"2019-02-28"}
promoter:地推员id
workType:工作类型,0:全部,1:办卡,2:销卡,3:取现
startDate:统计开始时间
endDate:统计结束时间
6.1.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":2,
"data": [{
"workDate":"2019-02-01",
"workCount":100,
"cashMoney":1000.00,
"cashCount":78,
"addUserCount":20,
"unbindCount":1
},{
"workDate":"2019-02-02",
"workCount":100,
"cashMoney":1000.00,
"cashCount":78,
"addUserCount":20,
"unbindCount":1
}]
}
状态码如下:
200:操作成功
202:[地推员不存在,工作类型不存在]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
workDate:工作日期
workCount:工作笔数
cashMoney:取现总额
cashCount:取现总次数
addUserCount:新增用户数
unbindCount:销户用户数
6.2地推员工作量明细查询
6.2.1接口说明
根据地推员id、工作类型查询工作明细
6.2.2接口地址
http://IP:Port/api/promoterwork/findWorkInfoDetails
6.2.3访问方式
get
6.2.4参数说明
{"promoterId":"1","workType":"1","startDate":"2019-02-01","endDate":"2019-02-01"}
promoterId:地推员id
workType:工作类型,0:全部,1:办卡,2:销卡,3: 取现
startDate:统计开始时间
endDate:统计结束时间
6.2.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":3,
"data": [{
"withdrawsId":null,
"workDatetime":"2019-02-01 09:20",
"userName":"张三",
"institutionName":"祥泰新河湾",
"workType":1,
"cashMoney":null
},{
"withdrawsId":1268,
"workDatetime":"2019-02-01 09:21",
"userName":"李四",
"institutionName":"祥泰新河湾",
"workType":3,
"cashMoney":20.0
},{
"withdrawsId":1269,
"workDatetime":"2019-02-01 09:25",
"userName":"王二",
"institutionName":"祥泰新河湾",
"workType":3,
"cashMoney":23.6
}]
}
状态码如下:
200:操作成功
202:[地推员不存在,工作类型不存在]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
withdrawsId:取现Id,该字段只有在workType=3的情况下有值。
workDatetime:工作时间
userName:用户名称
institutionName:小区名称
workType:工作类型,1:办卡,2:销卡,3: 取现
cashMoney:取现金额
6.3地推新增用户统计
6.3.1接口说明
查询地推员在时间范围内的地推新增用户统计信息
6.3.2接口地址
http://IP:Port/api/promoterwork/findPromotUserInfo
6.3.3访问方式
get
6.3.4参数说明
{"promoterId":1,"startDate":"2019-02-01","endDate":"2019-02-01"}
promoterId:地推员Id
startDate:统计开始时间
endDate:统计结束时间
6.3.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": {
"totalCount":200,
"wechatCount":100,
"cardCount":100
}
}
状态码如下:
200:操作成功
202:[地推员不存在]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
totalCount:新增用户总数
wechatCount:微信用户数
cardCount:卡用户数,新增的卡用户数
6.4空白卡查询
6.4.1接口说明
查询地推员在指定小区内指定日期的空白卡列表
6.4.2接口地址
http://IP:Port/api/promoterwork/findBlankCards
6.4.3访问方式
get
6.4.4参数说明
{"promoterId":"1","institutionId":1,"workDate":"2019-02-01"}
promoterId:地推员id;
institutionId:小区id;
workDate:工作日期。
6.4.5返回结果
参数为json数据,请求要求Context-type:application/json
{
"status": 200,
"message":"操作成功",
"total":1,
"data": {
"ungrants":[
{
"cardId":1,
"cardCode":"AABBCCDD",
"qcCode":"05310010012",
"grant":2
},
{
"cardId":2,
"cardCode":"AABBCCEE",
"qcCode":"05310010013",
"grant":2
}
],
"grants":[
{
"cardId":3,
"cardCode":"AABBCCFF",
"qcCode":"05310010014",
"grant":1
},
{
"cardId":4,
"cardCode":"AABBCCGG",
"qcCode":"05310010015",
"grant":1
}
]
}
}
状态码如下:
200:操作成功
202:[小区不存在,地推员不存在]
400:[参数缺失]
404:查询无数据
500:系统报错
数据项说明:
ungrants:未发放空白卡记录列表
grants:已发送空白卡记录列表
空白卡记录各数据项说明如下:
cardId:卡在卡库中的id
cardCode:卡芯片号
qcCode:卡面上的编号
grant:是否已经发放1:已发放,2:未发放