@sewise-dev
2019-06-28T01:25:03.000000Z
字数 8490
阅读 781
知识元 启业
| 编号 | 版本 | 说明 | 作者 | 日期 |
|---|---|---|---|---|
| 1 | v1.0 | 创建文档 | GuQiuSheng | 2019-04-23 |
/java/web/housekeeping/worker/add
application/json
POST
参数 必选 类型 说明 RequestBody name 是 String 名称 picture 是 String 照片 birthday 是 String 生日,格式为2019-04-29 id_num 是 String 身份证号码 phone 是 String 手机号码 education 是 String 文化水平 place 是 String 籍贯,格式为 广东-深圳 nation 是 String 民族 marriage 是 String 婚育情况 service_month 是 int 服务时间,以月为单位 service_num 是 int 服务数量 credentials 否 String 证书,如存在多个证书,格式为 xxx,xxx,xxx credentials_pic 否 String 证书图片,如存在多个证书图片,格式为 xxx,xxx,xxx speciality 是 String 专长 description 是 String 个人介绍 evaluate 是 String 评价 category_level 是 JSONArray 服务类型和技能评级,详情请见 Category_Level
Category_Level
参数 必选 类型 说明 category 是 int 服务类型,包括 1-月嫂 2-育婴师 3-保姆 4-催乳师 5-钟点工 level 是 int 技能等级,包括 0初级~9金牌
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| data | JSONObject | 返回数据,详细信息请见 Date Item |
| success | Boolean | 是否成功 |
| msg | String | 返回信息 |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| id | String | 记录id |
Request
Response
/java/web/housekeeping/worker/update
application/json
POST
参数 必选 类型 说明 RequestBody name 否 String 名称 picture 否 String 照片 birthday 否 String 生日,格式为2019-04-29 id_num 否 String 身份证号码 phone 否 String 手机号码 education 否 String 文化水平 place 否 String 籍贯,格式为 广东-深圳 nation 否 String 民族 marriage 否 String 婚育情况 service_month 否 int 服务时间,以月为单位 service_num 否 int 服务数量 credentials 否 String 证书,如存在多个证书,格式为 xxx,xxx,xxx credentials_pic 否 String 证书图片,如存在多个证书图片,格式为 xxx,xxx,xxx speciality 否 String 专长 description 否 String 个人介绍 evaluate 否 String 评价 category_level 否 JSONArray 服务类型和技能评级,详情请见 Category_Level
Category_Level
参数 必选 类型 说明 category 是 int 服务类型,包括 1-月嫂 2-育婴师 3-保姆 4-催乳师 5-钟点工 level 是 int 技能等级,包括 0初级~9金牌
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 |
| msg | String | 返回信息 |
Request
Response
/java/web/housekeeping/worker/delete
application/json
POST
参数 必选 类型 说明 RequestBody id 是 String 家政人员id
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| data | int | 返回数据 |
| success | Boolean | 是否成功 |
| msg | String | 返回信息 |
data
Response
{
"data": 1,
"success": true,
"msg": "操作成功"
}
/java/web/housekeeping/worker/query
application/json
GET
参数 必选 类型 说明 QureyParams id 是 int 家政人员id
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | Boolean | 请求结果 |
| data | JSONObject | 家政人员信息,详细请见接口【1.1 添加家政人员】输入参数 |
| msg | String | 返回信息 |
Request
Response
/java/web/housekeeping/worker/list
application/json
GET
参数 必选 类型 说明 QureyParams name 否 String 按名称模糊查询 place 否 String 按区域查询 category 否 int 按照服务类别查询 order 否 String 排序,可选 level和age page 否 int 请求页数 size 否 int 每页数量
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 |
| msg | String | 返回信息 |
| data | Array | 家政人员信息列表,详细信息请见 Data Item |
| size | int | 每页数量 |
| num | int | 第几页 |
| pages | int | 总页数 |
| total | int | 总数 |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| **请见接口【1.1 添加家政人员】的请求参数 |
Request
Response
/java/web/housekeeping/booking/update
POST
参数 必选 类型 说明 RequestBody id 是 int 预约ID from_date 否 String 预约开始时间,格式为 2019-04-29 to_date 否 String 预约结束时间 status 否 int 操作家政人员上岗(1),下岗(2)取消预约(4)
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
/java/web/housekeeping/booking/cancel
POST
参数 必选 类型 说明 RequestBody id 是 int 预约ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
/java/web/housekeeping/booking/list
GET
参数 必选 类型 说明 QueryParams name String 否 按照名称模糊查询 status int 否 按照服务状态查询,0-待面试 1-上岗 2-下岗(服务已完成) 4-取消预约 page 否 int 请求页数 size 否 int 每页数量
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回错误信息 |
| data | Array | 家政人员信息,详细信息请见 Data Item |
| size | int | 每页数量 |
| num | int | 第几页 |
| pages | int | 总页数 |
| total | int | 总数 |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| id | int | 预约ID |
| employer_id | int | 雇主id |
| employer_name | string | 雇主名称 |
| employer_phone | String | 雇主手机号码 |
| worker_id | int | 家政人员id |
| worker_name | string | 家政人员名称 |
| worker_phone | string | 家政人员手机号码 |
| worker_category | int | 服务类型 |
| worker_level | int | 服务级别 |
| booking_time | string | 预订时间,格式为 2019-04-29 12:00:00 |
| from_date | string | 服务开始时间,格式为 2019-04-29 |
| to_date | string | 服务结束时间,格式为 2019-04-29 |
| duration | int | 服务天数 |
| address | string | 服务地址 |
| live | int | 是否住家 |
| twins | int | 是否双胞胎 |
| price | float | 服务费用 |
| status | int | 服务状态 |
| create_time | String | 创建时间 |
/java/web/housekeeping/booking/worker
GET
参数 必选 类型 说明 QueryParams worker_id int 是 家政人员ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回错误信息 |
| data | Array | 家政人员信息,详细信息请见 Data Item |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| worker_id | int | 家政人员ID |
| list | Array | 已预约时间列表,详细信息请见 List Item |
List Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| from_date | String | 开始时间 |
| to_date | String | 结束时间 |
/java/housekeeping/worker/query
application/json
GET
参数 必选 类型 说明 QureyParams id 是 int 家政人员id employer_id 是 int 雇主ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 |
| msg | String | 返回错误信息 |
| data | JSONObject | 家政人员详细信息,请见Data Item |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| collect | int | 收藏数量 |
| isCollect | int | 雇主是否已收藏,1-已收藏,0-未收藏 |
| collect_id | int | 收藏ID,当isCollect=1时存在 |
| 其他返回结果请见【WEB-1.1 添加家政人员信息】的请求参数 |
Request
Response
/java/housekeeping/worker/list
application/json
GET
参数 必选 类型 说明 QureyParams category 是 int 按照服务类别查询 name 否 String 按名称模糊查询 place 否 String 按区域查询,格式为 广东-深圳 order 否 String 按年龄或者服务类别等级排序,包括 birthday level page 否 int 请求页数 size 否 int 每页数量
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功 |
| msg | String | 返回信息 |
| data | Array | 家政人员信息,详细信息请见 Data Item |
| size | int | 每页数量 |
| num | int | 第几页 |
| pages | int | 总页数 |
| total | int | 总数 |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| 请见接口【WEB-1.1添加家政人员】的请求参数 |
Request
Response
/java/housekeeping/booking/add
application/json
POST
参数 必选 类型 说明 employer_id 是 int 雇主id employer_name 是 string 雇主名称 employer_phone 是 String 雇主手机号码 worker_id 是 int 家政人员id worker_name 是 string 家政人员名称 worker_phone 是 string 家政人员手机号码 worker_category 是 int 服务类型 worker_level 是 int 服务级别 booking_time 是 string 预订时间,格式为 2019-04-29 12:00:00 from_date 是 string 服务开始时间,格式为 2019-04-29 to_date 是 string 服务结束时间,格式为 2019-04-29 duration 是 int 服务天数 address 是 string 服务地址 live 否 int 是否住家 twins 否 int 是否双胞胎 price 是 float 家政人员费用 commission 是 float 平台佣金 mode 是 String 雇佣方式,day/month/year
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | Boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | String | 添加失败原因 |
/java/housekeeping/booking/update
POST
参数 必选 类型 说明 RequestBody id 是 int 预约ID booking_time 否 string 预订时间,格式为 2019-04-29 12:00:00 from_date 否 string 服务开始时间,格式为 2019-04-29 to_date 否 string 服务结束时间,格式为 2019-04-29 duration 否 int 服务天数 address 否 string 服务地址 live 否 int 是否住家 twins 否 int 是否双胞胎 price 否 float 服务费用
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回失败原因 |
/java/housekeeping/booking/cancel
POST
参数 必选 类型 说明 RequestBody id 是 int 预约ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
/java/housekeeping/booking/delete
POST
参数 必选 类型 说明 RequestBody id 是 int 预约ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
/java/housekeeping/booking/query
GET
参数 必选 类型 说明 QueryParams id 是 int 预约ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
| data | JSONObject | 预约信息,详细参数请见 Data Item |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| 请见接口【2.1 添加预约】的请求参数 |
/java/housekeeping/booking/mylist
GET
参数 必选 类型 说明 QueryParams employer_id 是 int 雇主ID page 否 int 请求页数 size 否 int 每页数量
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
| data | JSONArray | 预约信息,详细参数请见 Data Item |
| size | int | 每页数量 |
| num | int | 第几页 |
| pages | int | 总页数 |
| total | int | 总数 |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| picture | String | 家政人员照片 |
| status | int | 预订状态,0-待面试 1-上岗 2-下岗(服务已完成) 4-取消预约 5-已删除 |
| 请见接口【2.1 添加预约】的请求参数 |
/java/housekeeping/booking/worker
GET
参数 必选 类型 说明 QueryParams worker_id int 是 家政人员ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回错误信息 |
| data | Array | 家政人员信息,详细信息请见 Data Item |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| worker_id | int | 家政人员ID |
| list | Array | 已预约时间列表,详细信息请见 List Item |
List Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| from_date | String | 开始时间 |
| to_date | String | 结束时间 |
/java/housekeeping/collect/add
POST
参数 必选 类型 说明 RequestBody worker_id 是 int 家政人员ID employer_id 是 int 雇主ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
/java/housekeeping/collect/cancel
POST
参数 必选 类型 说明 RequestBody id 是 int 收藏ID
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
/java/housekeeping/collect/mycollect
POST
参数 必选 类型 说明 RequestBody employer_id 是 int 雇主ID page 否 int 请求页数 size 否 int 每页数量
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 返回请求状态;true请求成功;false请求失败 |
| msg | string | 返回信息 |
| data | JSONArray | 已收藏的家政人员信息,详细参数请见 Data Item |
| size | int | 每页数量 |
| num | int | 第几页 |
| pages | int | 总页数 |
| total | int | 总数 |
Data Item
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| 请见接口【WEB-1.1添加家政人员】的请求参数 |