[关闭]
@sewise-dev 2019-06-28T01:25:03.000000Z 字数 8490 阅读 627

启业家政后台接口文档

知识元 启业


更新历史

编号 版本 说明 作者 日期
1 v1.0 创建文档 GuQiuSheng 2019-04-23

目录


Web

1. 家政人员

1.1 添加家政人员

接口地址

/java/web/housekeeping/worker/add

HTTP Content-Type

application/json

HTTP 请求方式

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金牌
HTTP 响应状态

200

返回字段 字段类型 说明
data JSONObject 返回数据,详细信息请见 Date Item
success Boolean 是否成功
msg String 返回信息

Data Item

返回字段 字段类型 说明
id String 记录id
接口示例

Request

Response

1.2 修改家政人员信息

接口地址

/java/web/housekeeping/worker/update

HTTP Content-Type

application/json

HTTP 请求方式

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金牌
HTTP 响应状态

200

返回字段 字段类型 说明
success Boolean 是否成功
msg String 返回信息
接口示例

Request

Response

1.3 删除家政人员

接口地址

/java/web/housekeeping/worker/delete

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
id String 家政人员id
HTTP 响应状态

200

返回字段 字段类型 说明
data int 返回数据
success Boolean 是否成功
msg String 返回信息

data

接口示例

Response
{
"data": 1,
"success": true,
"msg": "操作成功"
}

1.4 查询家政人员信息

接口地址

/java/web/housekeeping/worker/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QureyParams
id int 家政人员id
HTTP 响应状态

200

返回字段 字段类型 说明
success Boolean 请求结果
data JSONObject 家政人员信息,详细请见接口【1.1 添加家政人员】输入参数
msg String 返回信息
接口示例

Request

Response

1.5 查询家政人员列表

接口地址

/java/web/housekeeping/worker/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QureyParams
name String 按名称模糊查询
place String 按区域查询
category int 按照服务类别查询
order String 排序,可选 level和age
page int 请求页数
size int 每页数量
HTTP 响应状态

200

返回字段 字段类型 说明
success Boolean 是否成功
msg String 返回信息
data Array 家政人员信息列表,详细信息请见 Data Item
size int 每页数量
num int 第几页
pages int 总页数
total int 总数

Data Item

返回字段 字段类型 说明
**请见接口【1.1 添加家政人员】的请求参数
接口示例

Request

Response

2 家政预约

2.1 修改预约信息

接口地址

/java/web/housekeeping/booking/update

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
id int 预约ID
from_date String 预约开始时间,格式为 2019-04-29
to_date String 预约结束时间
status int 操作家政人员上岗(1),下岗(2)取消预约(4)
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息

2.2 取消预约

接口地址

/java/web/housekeeping/booking/cancel

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
id int 预约ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息

2.3 查询预约列表

接口地址

/java/web/housekeeping/booking/list

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParams
name String 按照名称模糊查询
status int 按照服务状态查询,0-待面试 1-上岗 2-下岗(服务已完成) 4-取消预约
page int 请求页数
size int 每页数量
HTTP 响应状态

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 创建时间

2.4 查询家政人员排班

接口地址

/java/web/housekeeping/booking/worker

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParams
worker_id int 家政人员ID
HTTP 响应状态

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 结束时间

APP

1 家政人员

1.1 查询家政人员信息

接口地址

/java/housekeeping/worker/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QureyParams
id int 家政人员id
employer_id int 雇主ID
HTTP 响应状态

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

1.2 查询家政人员列表

接口地址

/java/housekeeping/worker/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QureyParams
category int 按照服务类别查询
name String 按名称模糊查询
place String 按区域查询,格式为 广东-深圳
order String 按年龄或者服务类别等级排序,包括 birthday level
page int 请求页数
size int 每页数量
HTTP 响应状态

200

返回字段 字段类型 说明
success Boolean 是否成功
msg String 返回信息
data Array 家政人员信息,详细信息请见 Data Item
size int 每页数量
num int 第几页
pages int 总页数
total int 总数

Data Item

返回字段 字段类型 说明
请见接口【WEB-1.1添加家政人员】的请求参数
接口示例

Request

Response

2 家政预约

2.1 添加预约

接口地址

/java/housekeeping/booking/add

HTTP Content-Type

application/json

HTTP 请求方式

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
HTTP 响应状态

200

返回字段 字段类型 说明
success Boolean 返回请求状态;true请求成功;false请求失败
msg String 添加失败原因

2.2 修改预约信息

接口地址

/java/housekeeping/booking/update

HTTP 请求方式

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 服务费用
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回失败原因

2.3 取消预约

接口地址

/java/housekeeping/booking/cancel

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
id int 预约ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息

2.4 删除预约

接口地址

/java/housekeeping/booking/delete

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
id int 预约ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息

2.5 查询预约信息

接口地址

/java/housekeeping/booking/query

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParams
id int 预约ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息
data JSONObject 预约信息,详细参数请见 Data Item

Data Item

返回字段 字段类型 说明
请见接口【2.1 添加预约】的请求参数

2.6 我的预约列表

接口地址

/java/housekeeping/booking/mylist

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParams
employer_id int 雇主ID
page int 请求页数
size int 每页数量
HTTP 响应状态

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 添加预约】的请求参数

2.7 查询家政人员排班

接口地址

/java/housekeeping/booking/worker

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParams
worker_id int 家政人员ID
HTTP 响应状态

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 结束时间

3 收藏

3.1 添加收藏

接口地址

/java/housekeeping/collect/add

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
worker_id int 家政人员ID
employer_id int 雇主ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息

3.2 取消收藏

接口地址

/java/housekeeping/collect/cancel

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
id int 收藏ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息

3.3 我的收藏

接口地址

/java/housekeeping/collect/mycollect

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
employer_id int 雇主ID
page int 请求页数
size int 每页数量
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 返回请求状态;true请求成功;false请求失败
msg string 返回信息
data JSONArray 已收藏的家政人员信息,详细参数请见 Data Item
size int 每页数量
num int 第几页
pages int 总页数
total int 总数

Data Item

返回字段 字段类型 说明
请见接口【WEB-1.1添加家政人员】的请求参数
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注