# 接口说明 ## 通用接口 ### 上传图片 - `POST /upload` - 参数: 参数 | 类型 | 可选 | 备注 ----------- | ------ | ------ | -------- photo | png/jpeg | 必须 | 图片 - 响应: ``` { "status": 0, "path": "/path/photo.jpeg" } { "status": -1, "message": "error, photo is valid" } { "status": -2, "message": "error, error message" } ``` ### 添加订单评论 - `POST /{order_type}/{order_id}/comment` - 参数: 参数 | 类型 | 可选 | 备注 ----------- | ------ | ------ | -------- title | string | 必须 | 订单评论标题 content | string | 必须 | 评论内容 code | string | 必须 | 小程序code - 响应: ``` { "status": 0, "message": "保存成功" } { "status": -1, "message": "信息不能为空！" } ``` ### 分页获取订单评论 - `GET /{order_type}/{order_id}/comments` - 参数: 无 - 响应: ``` { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "first_page_url": "http://laravel.app?page=1", "last_page_url": "http://laravel.app?page=4", "next_page_url": "http://laravel.app?page=2", "prev_page_url": null, "path": "http://laravel.app", "from": 1, "to": 15, "data":[{ "id": 123456, "wechat_id": "wechat_id", "title": "测试标题", "content": "测试内容", "show": 0, // 预留字段, 0可视, 1隐藏 "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" }, ... ] } ``` ### 我的订单 - `GET /my/orders` - 参数: 参数 | 类型 | 可选 | 备注 ----------- | ------ | ------------------ | -------- code | string | 必须 | 小程序code - 响应: ``` { "status": 0, "data": { "houseApplianceCleanOrder": [ { "id": 123456, "wechat_id": "wechat_id", "appliances": "清洁项目1, 清洁项目1, 清洁项目2, 清洁项目3", "adress": "地址", "contact": "联系人", "phone": "13800138000", "price": 12.3, "status": 0, // 0.待处理 1.商家受理 2.待支付 3.已支付 "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" }, ... ], "houseCleanOrder": [ { "id": 123456, "wechat_id": "微信id", "type": "清洁类型", "area": "清洁面积", "adress": "地址", "contact": "联系人", "phone": "13800138000", "price": 12.3, "status": 0, // 0.待处理 1.商家受理 2.待支付 3.已支付 "picture1": "/commom/picture1.jepg", "picture2": "/commom/picture2.jepg", "picture3": "/commom/picture3.jepg", "picture4": "/commom/picture4.jepg", "picture5": "/commom/picture5.jepg", "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" }, ... ], "housekeeperOrder": [ ], "maternityMatronOrder": [ ], "productOrder": [ ] } } ``` ## 活动接口 ### 创建/修改活动 - `POST /campaign/store` - 参数： 参数 | 类型 | 可选 | 备注 ----------- | ------ | ------------------ | -------- id | integer | 创建时空，修改时必须 | 活动id title | string | 必须 | 标题 content | string | 必须 | 内容 status | integer | 可选,默认0 | 活动状态：0.进行中, 1.结束 - 响应: ``` { "status": 0, "message": "保存成功" } { "status": -1, "message": "信息不能为空！" } ``` ### 删除活动 - `DELETE /campaign/delete/${id}` - 参数：无 - 响应: ``` { "status": 0, "message": "删除成功" } { "status": -1, "message": "id不能为空！" } ``` ### 获得某活动 - `GET /campaign/${id}` - 参数： 无 - 响应： ``` { "status": 0, "data": { "id": 123456, "title": "测试标题", "content": "测试内容", "status": 0, "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" } } ``` ### 分页查询活动 - `GET /campaigns` - 参数： 无 - 响应: ``` { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "first_page_url": "http://laravel.app?page=1", "last_page_url": "http://laravel.app?page=4", "next_page_url": "http://laravel.app?page=2", "prev_page_url": null, "path": "http://laravel.app", "from": 1, "to": 15, "data":[{ "id": 123456, "title": "测试标题", "content": "测试内容", "status": 0, "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" }, ... ] } ``` ## 产品接口 ### 创建/修改产品 - `POST /product/store` - 参数： 参数 | 类型 | 可选 | 备注 ----------- | ------ | ------------------ | -------- id | integer | 创建时空，修改时必须 | 产品id name | string | 必须 | 产品名称 info | string | 必须 | 产品信息 color | string | 必须 | 产品款色 price | double | 必须 | 产品价格 classify | string | 必须 | 产品分类 status | integer | 可选,默认0 | 产品状态：0.上架, 1.下架 - 响应: ``` { "status": 0, "message": "保存成功" } { "status": -1, "message": "信息不能为空！" } ``` ### 删除产品 - `DELETE /product/delete/${id}` - 参数：无 - 响应: ``` { "status": 0, "message": "删除成功" } { "status": -1, "message": "id不能为空！" } ``` ### 获得某产品 - `GET /product/${id}` - 参数：无 - 响应： ``` { "status": 0, "data": { "id": 123456, "name": "测试名称", "info": "测试信息", "price": 1234.31, "classify": "分类1", "color": "款色", "collect_num": 765, //收藏数 "sell_num": 5, //销量 "status": 0, //0上架, 1下架 "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" } } ``` ### 分页查询产品 - `GET /products` - 参数： 无 - 响应: ``` { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "first_page_url": "http://laravel.app?page=1", "last_page_url": "http://laravel.app?page=4", "next_page_url": "http://laravel.app?page=2", "prev_page_url": null, "path": "http://laravel.app", "from": 1, "to": 15, "data":[ { "id": 123456, "name": "测试名称", "info": "测试信息", "price": 1234.31, "classify": "分类1", "color": "款色", "collect_num": 765, //收藏数 "sell_num": 5, //销量 "status": 0, //0上架, 1下架 "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" }, ... ] } ``` ## 家居清洁订单接口 ### 创建/修改家居清洁订单 - `POST /house_clean_order/store` - 参数： 参数 | 类型 | 可选 | 备注 ----------- | ------ | ------------------ | -------- id | integer | 创建时空，修改时必须 | 产品id code | string | 必须 | 小程序code type | integer | 必须 | 清洁类型 area | string | 必须 | 清洁面积 address | string | 必须 | 服务地址 contact | string | 必须 | 联系人 phone | string | 必须 | 联系电话 price | double | 可选 | 订单价格 status | integer | 可选,默认0 | 订单状态：0.待处理 1.商家受理 2.待支付 3.已支付 picture1 | string | 可选 | 图片链接 picture2 | string | 可选 | 图片链接 picture3 | string | 可选 | 图片链接 picture4 | string | 可选 | 图片链接 picture5 | string | 可选 | 图片链接 - 响应: ``` { "status": 0, "message": "保存成功" } { "status": -1, "message": "信息不能为空！" } ``` ### 删除订单 - `DELETE /house_clean_order/delete/${id}` - 参数：无 - 响应: ``` { "status": 0, "message": "删除成功" } { "status": -1, "message": "id不能为空！" } ``` ### 获得某订单 - `GET /house_clean_order/${id}` - 参数：无 - 响应： ``` { "status": 0, "data": { "id": 123456, "wechat_id": "微信id", "type": "清洁类型", "area": "清洁面积", "adress": "地址", "contact": "联系人", "phone": "13800138000", "price": 12.3, "status": 0, // 0.待处理 1.商家受理 2.待支付 3.已支付 "picture1": "/commom/picture1.jepg", "picture2": "/commom/picture2.jepg", "picture3": "/commom/picture3.jepg", "picture4": "/commom/picture4.jepg", "picture5": "/commom/picture5.jepg", "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" } } ``` ### 分页查询订单 - `GET /house_clean_orders` - 参数： 无 - 响应: ``` { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "first_page_url": "http://laravel.app?page=1", "last_page_url": "http://laravel.app?page=4", "next_page_url": "http://laravel.app?page=2", "prev_page_url": null, "path": "http://laravel.app", "from": 1, "to": 15, "data":[ { "id": 123456, "wechat_id": "微信id", "type": "清洁类型", "area": "清洁面积", "adress": "地址", "contact": "联系人", "phone": "13800138000", "price": 12.3, "status": 0, // 0.待处理 1.商家受理 2.待支付 3.已支付 "picture1": "/commom/picture1.jepg", "picture2": "/commom/picture2.jepg", "picture3": "/commom/picture3.jepg", "picture4": "/commom/picture4.jepg", "picture5": "/commom/picture5.jepg", "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" }, ... ] } ``` ## 家电清洁订单接口 ### 创建/修改订单 - `POST /house_appliance_clean_order/store` - 参数： 参数 | 类型 | 可选 | 备注 ----------- | ------ | ------------------ | -------- id | integer | 创建时空，修改时必须 | 产品id code | string | 必须 | 小程序code appliances | string | 必须 | 项目, 数组形式，多个数量则出现多次 address | string | 必须 | 服务地址 contact | string | 必须 | 联系人 phone | string | 必须 | 联系电话 price | double | 可选 | 订单价格 status | integer | 可选,默认0 | 订单状态：0.待处理 1.商家受理 2.待支付 3.已支付 - 响应: ``` { "status": 0, "message": "保存成功" } { "status": -1, "message": "信息不能为空！" } ``` ### 删除订单 - `DELETE /house_appliance_clean_order/delete/${id}` - 参数：无 - 响应: ``` { "status": 0, "message": "删除成功" } { "status": -1, "message": "id不能为空！" } ``` ### 获得某订单 - `GET /house_appliance_clean_order/${id}` - 参数：无 - 响应： ``` { "status": 0, "data": { "id": 123456, "wechat_id": "wechat_id", "appliances": "清洁项目1, 清洁项目1, 清洁项目2, 清洁项目3", "adress": "地址", "contact": "联系人", "phone": "13800138000", "price": 12.3, "status": 0, // 0.待处理 1.商家受理 2.待支付 3.已支付 "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" } } ``` ### 分页查询订单 - `GET /house_appliance_clean_orders` - 参数： 无 - 响应: ``` { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "first_page_url": "http://laravel.app?page=1", "last_page_url": "http://laravel.app?page=4", "next_page_url": "http://laravel.app?page=2", "prev_page_url": null, "path": "http://laravel.app", "from": 1, "to": 15, "data":[ { "id": 123456, "wechat_id": "wechat_id", "appliances": "清洁项目1, 清洁项目1, 清洁项目2, 清洁项目3", "adress": "地址", "contact": "联系人", "phone": "13800138000", "price": 12.3, "status": 0, // 0.待处理 1.商家受理 2.待支付 3.已支付 "created_at": "2018-02-16 11:10:56", "updated_at": "2018-02-16 12:00:51" }, ... ] } ```