README.md
5af620a9b412be0085d7b95e7bf81e615ac2e09a#">乐游图后端接口文档
Specification | Value |
---|---|
API Version | 1.0.0 |
BasePath | https://letu.api.imagchina.com |
API List
- 增加访问日志
- 查询所有商品
- 查询所有游玩项目
- 查询所有线路
- 所有景区基础信息
- 查询商品信息
- 增加投诉
- 增加调查
- 查询设备信息
- 查询线路信息
- 用户登录&注册
- 返回景区基础信息
- 发送短信验证码
- 标签列表
- 更新商品
- 更新设施
- 更新等待时间
- 更新线路
- 更新景区基础信息
- 修改用户信息
- 上传
- 获取用户信息
/AccessLog (POST)
增加访问日志
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
UserId | 5dfb03070a9ac17ac7a82054 | string | 用户ID | Yes |
UserName | Aaron | string | 用户名称 | Yes |
TypeNum | 9 | int | 类型编号 | Yes |
TypeName | 点击个人中心 | string | 类型名称 | Yes |
DateTime | 1578556751220 | int | 时间戳 | Yes |
Location | {"Latitude": 119, "Longitude": 39} | string | 位置 | Yes |
Remarks | 备注 | string | 备注 | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/AllCommodity (GET)
查询所有商品
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Price=价格;ShopName=店铺名称;KvPhoto用于列表页的图片;TopPhoto详情页最上面的轮播图;Images详情页下面的产品详细图 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/AllItems (GET)
查询所有游玩项目
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Tags所属标签,标签有分类;LimitHeight限高;PlayDuration游玩时长;SceneTime场次时间;Picture照片;Voice音频;AverageConsumption平均消费;Menu菜单 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/AllLine (GET)
查询所有线路
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Name名称;SubName副标题;PlayDuration游玩时长;Suitable适合人群;Location线路点坐标;Annotations需要点亮的设施id;Distance距离 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/AllScenic (GET)
所有景区基础信息
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/CommodityInfo (GET)
查询商品信息
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
id | 5dfb03070a9ac17ac7a82054 | string | id | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Price=价格;ShopName=店铺名称;KvPhoto用于列表页的图片;TopPhoto详情页最上面的轮播图;Images详情页下面的产品详细图 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/CreateComplaint (POST)
增加投诉
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
mobile | 18616619599 | string | 联系电话 | Yes |
type | 1 | string | 类型 | Yes |
content | 卫生不干净 | string | 投诉内容 | Yes |
image | ["http://www.xx.com/123.jpg","http://www.xx.com/123.jpg"] | string | 照片数组 | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":"ok"} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/Investigation/Save (POST)
增加调查
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
UserId | 1111111 | string | UserId | Yes |
Mobile | 18616619599 | string | 联系电话 | Yes |
type | 1 | string | 类型 | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":"ok"} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/ItemInfo (GET)
查询设备信息
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
id | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/LineInfo (GET)
查询线路信息
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
id | 5dfb03070a9ac17ac7a82054 | string | id | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Name名称;SubName副标题;PlayDuration游玩时长;Suitable适合人群;Location线路点坐标;Annotations需要点亮的设施id;Distance距离 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/LoginUser (POST)
用户登录&注册
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
mobile | aaron | string | 手机号 | Yes |
password | 1 | string | 密码或验证码(使用验证码的新手机号自动注册) | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} 调用其它需要登陆的接口时携带token,有过期时间 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/ScenicInfo (GET)
返回景区基础信息
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
id | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Name名称;Describe介绍;OpenHours营业时间;Picture最上面图片;ShopAdPicture商城列表页图片;ItemScenicPicture项目场次照片;ActivityPicture活动照片;VideoList视频 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/Sms/Send (POST)
发送短信验证码
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
Mobile | 18616619599 | string | 手机号 | Yes |
Location | {"Latitude": 119, "Longitude": 39} | string | 位置 | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":"ok"}验证码3分钟内有效 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/Tags (GET)
标签列表
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":[{"Type":"menu","Name":"服务设施"},{"Type":"normal","Name":"不错"},{"Type":"thrilling","Name":"刺激"},{"Type":"recommend","Name":"必玩"}]} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/UpdateCommodity (POST)
更新商品
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/UpdateItem (POST)
更新设施
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Tags所属标签,标签有分类;LimitHeight限高;PlayDuration游玩时长;SceneTime场次时间;Picture照片;Voice音频;AverageConsumption平均消费;Menu菜单 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/UpdateItemTime (POST)
更新等待时间
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
item | [{"id":"5df864740a9ac17ac7a7feb8","time":"20"},{"id":"5df8660924e03417008b4567","time":"33"}] | string | 设备列表 | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {errcode: 0, result: "ok"} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/UpdateLine (POST)
更新线路
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/UpdateScenic (POST)
更新景区基础信息
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
id | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | Name名称;Describe介绍;OpenHours营业时间;Picture最上面图片;ShopAdPicture商城列表页图片;ItemScenicPicture项目场次照片;ActivityPicture活动照片;VideoList视频 |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/UpdateUser (POST)
修改用户信息
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
password | 1 | string | 密码 | Yes |
confirmpassword | 1 | string | 确认密码 | Yes |
birthday | 2010.10.10 | string | 生日 | Yes |
fullname | aarongao | string | 全名 | Yes |
code | 12345678 | string | 6位验证码 | Yes |
mobile | 18616619599 | string | 手机,同用户名 | Yes |
openid | 12345 | string | 微信id | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":"ok"} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/Upload (POST)
上传
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
file | 1 | file | 文件 | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":"图片地址"} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |
/UserInfo (GET)
获取用户信息
Param Name | Example | Data Type | Description | Required? |
---|---|---|---|---|
id | aaron | string | 用户id | Yes |
Code | Type | Model | Message |
---|---|---|---|
200 | object | ResponseSeccess | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} |
500 | object | ResponseError | {"errcode":1,"errmsg":"错误原因"} |