aarongao / leyoutu_server

Download as
Browse Code »

Commit dc2b95ebc3a1a9d94edd279bc4f1bd77f1fc6b76

Authored by aarongao
1 parent 025a2fc1
Exists in v1.2 and in 1 other branch v1.1

.

Showing 1 changed file with 0 additions and 816 deletions   Show diff stats
README.md
  Diff comments   View file @dc2b95e
... ... @@ -1,816 +0,0 @@
1   -
2   -## 乐游图后端接口文档
3   -| Specification | Value |
4   -|-----|-----|
5   -| API Version | 1.0.0 |
6   -| BasePath | 正式 leyoutu.st-i.com.cn; 测试 leyoutu.sti-uat.com |
7   -
8   -
9   -
10   -### API List
11   -1. [查询所有商品](#allcommodity-get)
12   -1. [投诉 - 查询所有投诉](#allcomplaint-get)
13   -1. [设备管理 - 获得所有设备的等待时间](#allitemtime-get)
14   -1. [设备管理 - 查询所有游玩项目](#allitems-get)
15   -1. [查询所有线路](#allline-get)
16   -1. [所有景区基础信息](#allscenic-get)
17   -1. [标签 - 所有标签](#alltag-get)
18   -1. [标签 - 按照标签分组查看所有标签](#alltaggroup-get)
19   -1. [用户管理 - 检查Token是否过期](#checktoken-post)
20   -1. [查询商品信息](#commodityinfo-get)
21   -1. [投诉 - 增加投诉](#createcomplaint-post)
22   -1. [查询用户的定时提醒](#dealymessage-info-get)
23   -1. [创建提醒](#dealymessage-create-post)
24   -1. [删除提醒](#dealymessage-remove-post)
25   -1. [图标管理 - 返回图标基础信息](#icon-info-get)
26   -1. [图标管理 - 增加或修改图标信息](#icon-update-post)
27   -1. [图标管理 - 所有图标](#icon-all-get)
28   -1. [问券调查 - 增加调查](#investigation-save-post)
29   -1. [问券调查 - 查询所有问券调查](#investigation-list-get)
30   -1. [设备管理 - 查询设备信息](#iteminfo-get)
31   -1. [查询线路信息](#lineinfo-get)
32   -1. [用户管理 - 用户登录&注册](#loginuser-post)
33   -1. [用户管理 - 注册客户端](#registerdevice-post)
34   -1. [用户管理 - 删除用户（注销）](#removeuser-post)
35   -1. [返回景区基础信息](#scenicinfo-get)
36   -1. [发送短信验证码](#sms-send-post)
37   -1. [标签 - 增加标签](#tag-create-post)
38   -1. [标签 - 删除标签](#tag-remove-post)
39   -1. [菜单管理 - 查询所有菜单](#topmenus-all-get)
40   -1. [菜单管理 - 更新菜单](#topmenus-update-post)
41   -1. [保存用户移动轨迹(5分钟提交一次)](#trajectory-save-post)
42   -1. [更新商品](#updatecommodity-post)
43   -1. [设备管理 - 更新设施](#updateitem-post)
44   -1. [设备管理 - 更新等待时间](#updateitemtime-post)
45   -1. [更新线路](#updateline-post)
46   -1. [更新景区基础信息](#updatescenic-post)
47   -1. [用户管理 - 修改用户信息](#updateuser-post)
48   -1. [上传](#upload-post)
49   -1. [用户管理 - 获取用户信息](#userinfo-get)
50   -1. [增加用户行为日志](#userlog-post)
51   -
52   -
53   -
54   -<a name="allcommodity-get"></a>
55   -
56   -#### /AllCommodity (GET)
57   -
58   -
59   -查询所有商品
60   -
61   -| Code | Type | Model | Message |
62   -|-----|-----|-----|-----|
63   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Price=价格；ShopName=店铺名称；KvPhoto用于列表页的图片；TopPhoto详情页最上面的轮播图；Images详情页下面的产品详细图 |
64   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
65   -
66   -
67   -
68   -<a name="allcomplaint-get"></a>
69   -
70   -#### /AllComplaint (GET)
71   -
72   -
73   -投诉 - 查询所有投诉
74   -
75   -| Param Name | Example | Data Type | Description | Required? |
76   -|-----|-----|-----|-----|-----|
77   -| Page | 1 | int | 当前第几页 | Yes |
78   -
79   -
80   -| Code | Type | Model | Message |
81   -|-----|-----|-----|-----|
82   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | |
83   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
84   -
85   -
86   -
87   -<a name="allitemtime-get"></a>
88   -
89   -#### /AllItemTime (GET)
90   -
91   -
92   -设备管理 - 获得所有设备的等待时间
93   -
94   -| Code | Type | Model | Message |
95   -|-----|-----|-----|-----|
96   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {5df864740a9ac17ac7a7feb8: '20',.....} |
97   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {} |
98   -
99   -
100   -
101   -<a name="allitems-get"></a>
102   -
103   -#### /AllItems (GET)
104   -
105   -
106   -设备管理 - 查询所有游玩项目
107   -
108   -| Code | Type | Model | Message |
109   -|-----|-----|-----|-----|
110   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Tags所属标签，标签有分类；LimitHeight限高；PlayDuration游玩时长；SceneTime场次时间；Picture照片；Voice音频；AverageConsumption平均消费；Menu菜单, OpenHours开放时间: LocationDescription位置描述; Reminder温馨提示; State运行状态0=正常1=停运 |
111   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
112   -
113   -
114   -
115   -<a name="allline-get"></a>
116   -
117   -#### /AllLine (GET)
118   -
119   -
120   -查询所有线路
121   -
122   -| Code | Type | Model | Message |
123   -|-----|-----|-----|-----|
124   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称；SubName副标题；PlayDuration游玩时长；Suitable适合人群；Location线路点坐标；Annotations需要点亮的设施id；Distance距离 |
125   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
126   -
127   -
128   -
129   -<a name="allscenic-get"></a>
130   -
131   -#### /AllScenic (GET)
132   -
133   -
134   -所有景区基础信息
135   -
136   -| Code | Type | Model | Message |
137   -|-----|-----|-----|-----|
138   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | |
139   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
140   -
141   -
142   -
143   -<a name="alltag-get"></a>
144   -
145   -#### /AllTag (GET)
146   -
147   -
148   -标签 - 所有标签
149   -
150   -| Param Name | Example | Data Type | Description | Required? |
151   -|-----|-----|-----|-----|-----|
152   -| ScenicId | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
153   -
154   -
155   -| Code | Type | Model | Message |
156   -|-----|-----|-----|-----|
157   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":[{"Type":"menu","Name":"服务设施"},{"Type":"normal","Name":"不错"},{"Type":"thrilling","Name":"刺激"},{"Type":"recommend","Name":"必玩"}]} |
158   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
159   -
160   -
161   -
162   -<a name="alltaggroup-get"></a>
163   -
164   -#### /AllTagGroup (GET)
165   -
166   -
167   -标签 - 按照标签分组查看所有标签
168   -
169   -| Param Name | Example | Data Type | Description | Required? |
170   -|-----|-----|-----|-----|-----|
171   -| ScenicId | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
172   -
173   -
174   -| Code | Type | Model | Message |
175   -|-----|-----|-----|-----|
176   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":[{"Tags":["儿童","成人","青少年"],"Type":"age"}]} |
177   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
178   -
179   -
180   -
181   -<a name="checktoken-post"></a>
182   -
183   -#### /CheckToken (POST)
184   -
185   -
186   -用户管理 - 检查Token是否过期
187   -
188   -| Param Name | Example | Data Type | Description | Required? |
189   -|-----|-----|-----|-----|-----|
190   -| id | aaron | string | 用户id | Yes |
191   -| Token | wgergejfwe | string | 用户token | Yes |
192   -
193   -
194   -| Code | Type | Model | Message |
195   -|-----|-----|-----|-----|
196   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
197   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":401,"errmsg":"token过期"} |
198   -
199   -
200   -
201   -<a name="commodityinfo-get"></a>
202   -
203   -#### /CommodityInfo (GET)
204   -
205   -
206   -查询商品信息
207   -
208   -| Param Name | Example | Data Type | Description | Required? |
209   -|-----|-----|-----|-----|-----|
210   -| id | 5dfb03070a9ac17ac7a82054 | string | id | Yes |
211   -
212   -
213   -| Code | Type | Model | Message |
214   -|-----|-----|-----|-----|
215   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Price=价格；ShopName=店铺名称；KvPhoto用于列表页的图片；TopPhoto详情页最上面的轮播图；Images详情页下面的产品详细图 |
216   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
217   -
218   -
219   -
220   -<a name="createcomplaint-post"></a>
221   -
222   -#### /CreateComplaint (POST)
223   -
224   -
225   -投诉 - 增加投诉
226   -
227   -| Param Name | Example | Data Type | Description | Required? |
228   -|-----|-----|-----|-----|-----|
229   -| Mobile | 18616619599 | string | 联系电话 | Yes |
230   -| Name | 高先生 | string | 姓名 | Yes |
231   -| Code | 123456 | string | 验证码 | Yes |
232   -| Sex | 男 | string | 性别 | Yes |
233   -| ScenicId | 5e1ed07524e03431008b4572 | string | 景区id | Yes |
234   -| Type | 1 | string | 类型 | Yes |
235   -| Content | 卫生不干净 | string | 投诉内容 | Yes |
236   -| Image | ["http://www.xx.com/123.jpg","http://www.xx.com/123.jpg"] | string | 照片数组 | Yes |
237   -
238   -
239   -| Code | Type | Model | Message |
240   -|-----|-----|-----|-----|
241   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
242   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
243   -
244   -
245   -
246   -<a name="dealymessage-info-get"></a>
247   -
248   -#### /DealyMessage/Info (GET)
249   -
250   -
251   -查询用户的定时提醒
252   -
253   -| Param Name | Example | Data Type | Description | Required? |
254   -|-----|-----|-----|-----|-----|
255   -| UserId | 5dfb03070a9ac17ac7a82054 | string | 用户id | Yes |
256   -| Token | wgergejfwe | string | 用户token | Yes |
257   -
258   -
259   -| Code | Type | Model | Message |
260   -|-----|-----|-----|-----|
261   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | DelayTime=执行时间;Type=类型(0请求url地址1发送app通知);Fail失败次数;Title=通知标题;Content=通知内容;UDID=设备id |
262   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
263   -
264   -
265   -<a name="dealymessage-create-post"></a>
266   -
267   -#### /DealyMessage/Create (POST)
268   -
269   -
270   -创建提醒
271   -
272   -| Param Name | Example | Data Type | Description | Required? |
273   -|-----|-----|-----|-----|-----|
274   -| UserId | 5dfb03070a9ac17ac7a82054 | string | 用户id | Yes |
275   -| Token | wgergejfwe | string | 用户token | Yes |
276   -| UDID | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes |
277   -| Title | 表演时间提醒 | string | 标题 | Yes |
278   -| Content | 5分钟后有表演 | string | 内容 | Yes |
279   -| DelayTime | 1579066863 | string | 到达这个时间戳就执行 | Yes |
280   -
281   -
282   -| Code | Type | Model | Message |
283   -|-----|-----|-----|-----|
284   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
285   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
286   -
287   -
288   -<a name="dealymessage-remove-post"></a>
289   -
290   -#### /DealyMessage/Remove (POST)
291   -
292   -
293   -删除提醒
294   -
295   -| Param Name | Example | Data Type | Description | Required? |
296   -|-----|-----|-----|-----|-----|
297   -| id | 5dfb03070a9ac17ac7a82054 | string | 提醒id | Yes |
298   -| UserId | 5dfb03070a9ac17ac7a82054 | string | 用户id | Yes |
299   -| Token | wgergejfwe | string | 用户token | Yes |
300   -
301   -
302   -| Code | Type | Model | Message |
303   -|-----|-----|-----|-----|
304   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
305   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
306   -
307   -
308   -
309   -<a name="icon-info-get"></a>
310   -
311   -#### /Icon/Info (GET)
312   -
313   -
314   -图标管理 - 返回图标基础信息
315   -
316   -| Param Name | Example | Data Type | Description | Required? |
317   -|-----|-----|-----|-----|-----|
318   -| id | 5dfb03070a9ac17ac7a82054 | string | 图标id | Yes |
319   -
320   -
321   -| Code | Type | Model | Message |
322   -|-----|-----|-----|-----|
323   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称:Picture图片地址:id图标id |
324   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
325   -
326   -
327   -<a name="icon-update-post"></a>
328   -
329   -#### /Icon/Update (POST)
330   -
331   -
332   -图标管理 - 增加或修改图标信息
333   -
334   -| Param Name | Example | Data Type | Description | Required? |
335   -|-----|-----|-----|-----|-----|
336   -| id | 5dfb03070a9ac17ac7a82054 | string | 图标id | Yes |
337   -
338   -
339   -| Code | Type | Model | Message |
340   -|-----|-----|-----|-----|
341   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称:Picture图片地址:id图标id:ScenicId景区id |
342   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
343   -
344   -
345   -<a name="icon-all-get"></a>
346   -
347   -#### /Icon/All (GET)
348   -
349   -
350   -图标管理 - 所有图标
351   -
352   -| Param Name | Example | Data Type | Description | Required? |
353   -|-----|-----|-----|-----|-----|
354   -| ScenicId | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
355   -
356   -
357   -| Code | Type | Model | Message |
358   -|-----|-----|-----|-----|
359   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称:Picture图片地址:id图标id:ScenicId景区id |
360   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
361   -
362   -
363   -
364   -<a name="investigation-save-post"></a>
365   -
366   -#### /Investigation/Save (POST)
367   -
368   -
369   -问券调查 - 增加调查
370   -
371   -| Param Name | Example | Data Type | Description | Required? |
372   -|-----|-----|-----|-----|-----|
373   -| UserId | 1111111 | string | UserId | Yes |
374   -| Mobile | 18616619599 | string | 联系电话 | Yes |
375   -| type | 1 | string | 类型 | Yes |
376   -
377   -
378   -| Code | Type | Model | Message |
379   -|-----|-----|-----|-----|
380   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
381   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
382   -
383   -
384   -<a name="investigation-list-get"></a>
385   -
386   -#### /Investigation/List (GET)
387   -
388   -
389   -问券调查 - 查询所有问券调查
390   -
391   -| Param Name | Example | Data Type | Description | Required? |
392   -|-----|-----|-----|-----|-----|
393   -| Page | 1 | int | 当前第几页 | Yes |
394   -
395   -
396   -| Code | Type | Model | Message |
397   -|-----|-----|-----|-----|
398   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"total":1,"currpage":1,"totalpages":1,"prepage":20,"result":} |
399   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
400   -
401   -
402   -
403   -<a name="iteminfo-get"></a>
404   -
405   -#### /ItemInfo (GET)
406   -
407   -
408   -设备管理 - 查询设备信息
409   -
410   -| Param Name | Example | Data Type | Description | Required? |
411   -|-----|-----|-----|-----|-----|
412   -| id | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes |
413   -
414   -
415   -| Code | Type | Model | Message |
416   -|-----|-----|-----|-----|
417   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Tags所属标签，标签有分类；LimitHeight限高；PlayDuration游玩时长；SceneTime场次时间；Picture照片；Voice音频；AverageConsumption平均消费；Menu菜单, OpenHours开放时间: LocationDescription位置描述; Reminder温馨提示; State运行状态0=正常1=停运 |
418   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
419   -
420   -
421   -
422   -<a name="lineinfo-get"></a>
423   -
424   -#### /LineInfo (GET)
425   -
426   -
427   -查询线路信息
428   -
429   -| Param Name | Example | Data Type | Description | Required? |
430   -|-----|-----|-----|-----|-----|
431   -| id | 5dfb03070a9ac17ac7a82054 | string | id | Yes |
432   -
433   -
434   -| Code | Type | Model | Message |
435   -|-----|-----|-----|-----|
436   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称；SubName副标题；PlayDuration游玩时长；Suitable适合人群；Location线路点坐标；Annotations需要点亮的设施id；Distance距离 |
437   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
438   -
439   -
440   -
441   -<a name="loginuser-post"></a>
442   -
443   -#### /LoginUser (POST)
444   -
445   -
446   -用户管理 - 用户登录&注册
447   -
448   -| Param Name | Example | Data Type | Description | Required? |
449   -|-----|-----|-----|-----|-----|
450   -| Mobile | aaron | string | 手机号 | Yes |
451   -| Code | 1 | string | 验证码(使用验证码的新手机号自动注册) | Yes |
452   -| DeviceId | abc123 | string | 手机唯一识别码,不重复(存放于http.header中) | |
453   -| Mac | abc123 | string | 网卡Mac地址(存放于http.header中) | |
454   -| SystemType | ios | string | ios,android(存放于http.header中) | |
455   -| SystemVersion | 13.01 | string | 手机版本(存放于http.header中) | |
456   -| SystemModel | iphone8 | string | 手机型号(存放于http.header中) | |
457   -| AppVersion | 1.0 | string | app版本号(存放于http.header中) | |
458   -| DeviceToken | abc | string | 推送token(存放于http.header中) | |
459   -
460   -
461   -| Code | Type | Model | Message |
462   -|-----|-----|-----|-----|
463   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} 调用其它需要登陆的接口时携带token,有过期时间 |
464   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
465   -
466   -
467   -
468   -<a name="registerdevice-post"></a>
469   -
470   -#### /RegisterDevice (POST)
471   -
472   -
473   -用户管理 - 注册客户端
474   -
475   -| Param Name | Example | Data Type | Description | Required? |
476   -|-----|-----|-----|-----|-----|
477   -| DeviceId | abc123 | string | 手机唯一识别码,不重复(存放于http.header中) | |
478   -| Mac | abc123 | string | 网卡Mac地址(存放于http.header中) | |
479   -| SystemType | ios | string | ios,android(存放于http.header中) | |
480   -| SystemVersion | 13.01 | string | 手机版本(存放于http.header中) | |
481   -| SystemModel | iphone8 | string | 手机型号(存放于http.header中) | |
482   -| AppVersion | 1.0 | string | app版本号(存放于http.header中) | |
483   -| DeviceToken | abc | string | 推送token(存放于http.header中) | |
484   -
485   -
486   -| Code | Type | Model | Message |
487   -|-----|-----|-----|-----|
488   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
489   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
490   -
491   -
492   -
493   -<a name="removeuser-post"></a>
494   -
495   -#### /RemoveUser (POST)
496   -
497   -
498   -用户管理 - 删除用户（注销）
499   -
500   -| Param Name | Example | Data Type | Description | Required? |
501   -|-----|-----|-----|-----|-----|
502   -| id | aaron | string | 用户id | Yes |
503   -| Token | wgergejfwe | string | 用户token | Yes |
504   -
505   -
506   -| Code | Type | Model | Message |
507   -|-----|-----|-----|-----|
508   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
509   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
510   -
511   -
512   -
513   -<a name="scenicinfo-get"></a>
514   -
515   -#### /ScenicInfo (GET)
516   -
517   -
518   -返回景区基础信息
519   -
520   -| Param Name | Example | Data Type | Description | Required? |
521   -|-----|-----|-----|-----|-----|
522   -| id | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
523   -
524   -
525   -| Code | Type | Model | Message |
526   -|-----|-----|-----|-----|
527   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称；Describe介绍；OpenHours营业时间；Picture最上面图片；ShopAdPicture商城列表页图片；ItemScenicPicture项目场次照片；ActivityPicture活动照片；VideoList视频(VideoPicture=首桢图片);InvestigationUrl问券调查的url；RangeLocation景区范围（多个坐标点） |
528   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
529   -
530   -
531   -
532   -<a name="sms-send-post"></a>
533   -
534   -#### /Sms/Send (POST)
535   -
536   -
537   -发送短信验证码
538   -
539   -| Param Name | Example | Data Type | Description | Required? |
540   -|-----|-----|-----|-----|-----|
541   -| Mobile | 18616619599 | string | 手机号 | Yes |
542   -| Location | {"Latitude": 119, "Longitude": 39} | string | 位置 | Yes |
543   -
544   -
545   -| Code | Type | Model | Message |
546   -|-----|-----|-----|-----|
547   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"}验证码1分钟内有效 |
548   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
549   -
550   -
551   -
552   -<a name="tag-create-post"></a>
553   -
554   -#### /Tag/Create (POST)
555   -
556   -
557   -标签 - 增加标签
558   -
559   -| Param Name | Example | Data Type | Description | Required? |
560   -|-----|-----|-----|-----|-----|
561   -| ScenicId | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
562   -| TagName | 广场 | string | 标签名称 | Yes |
563   -| TagGroup | location | string | 群组名称 | Yes |
564   -
565   -
566   -| Code | Type | Model | Message |
567   -|-----|-----|-----|-----|
568   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
569   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
570   -
571   -
572   -<a name="tag-remove-post"></a>
573   -
574   -#### /Tag/Remove (POST)
575   -
576   -
577   -标签 - 删除标签
578   -
579   -| Param Name | Example | Data Type | Description | Required? |
580   -|-----|-----|-----|-----|-----|
581   -| ScenicId | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
582   -| TagName | 广场 | string | 标签名称 | Yes |
583   -| TagGroup | location | string | 群组名称 | Yes |
584   -
585   -
586   -| Code | Type | Model | Message |
587   -|-----|-----|-----|-----|
588   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
589   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
590   -
591   -
592   -
593   -<a name="topmenus-all-get"></a>
594   -
595   -#### /TopMenus/All (GET)
596   -
597   -
598   -菜单管理 - 查询所有菜单
599   -
600   -| Code | Type | Model | Message |
601   -|-----|-----|-----|-----|
602   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":[{"Id":"","ScenicId":"","Title":"玩水","Tags":["玩水"]},{"Id":"","ScenicId":"","Title":"设施","Tags":["服务设施","游玩项目"]}]} |
603   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
604   -
605   -
606   -<a name="topmenus-update-post"></a>
607   -
608   -#### /TopMenus/Update (POST)
609   -
610   -
611   -菜单管理 - 更新菜单
612   -
613   -| Code | Type | Model | Message |
614   -|-----|-----|-----|-----|
615   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":[{"Id":"","ScenicId":"","Title":"玩水","Tags":["玩水"]},{"Id":"","ScenicId":"","Title":"设施","Tags":["服务设施","游玩项目"]}]} |
616   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
617   -
618   -
619   -
620   -<a name="trajectory-save-post"></a>
621   -
622   -#### /Trajectory/Save (POST)
623   -
624   -
625   -保存用户移动轨迹(5分钟提交一次)
626   -
627   -| Param Name | Example | Data Type | Description | Required? |
628   -|-----|-----|-----|-----|-----|
629   -| UserId | 5dfb03070a9ac17ac7a82054 | string | 用户id | Yes |
630   -| Location | {"Latitude": 119, "Longitude": 39} | string | 经纬度 | Yes |
631   -
632   -
633   -| Code | Type | Model | Message |
634   -|-----|-----|-----|-----|
635   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
636   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
637   -
638   -
639   -
640   -<a name="updatecommodity-post"></a>
641   -
642   -#### /UpdateCommodity (POST)
643   -
644   -
645   -更新商品
646   -
647   -| Code | Type | Model | Message |
648   -|-----|-----|-----|-----|
649   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | |
650   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
651   -
652   -
653   -
654   -<a name="updateitem-post"></a>
655   -
656   -#### /UpdateItem (POST)
657   -
658   -
659   -设备管理 - 更新设施
660   -
661   -| Code | Type | Model | Message |
662   -|-----|-----|-----|-----|
663   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Tags所属标签，标签有分类；LimitHeight限高；PlayDuration游玩时长；SceneTime场次时间；Picture照片；Voice音频；AverageConsumption平均消费；Menu菜单, OpenHours开放时间: LocationDescription位置描述; Reminder温馨提示; State运行状态0=正常1=停运 |
664   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
665   -
666   -
667   -
668   -<a name="updateitemtime-post"></a>
669   -
670   -#### /UpdateItemTime (POST)
671   -
672   -
673   -设备管理 - 更新等待时间
674   -
675   -| Param Name | Example | Data Type | Description | Required? |
676   -|-----|-----|-----|-----|-----|
677   -| item | [{"id":"5df864740a9ac17ac7a7feb8","time":"20"},{"id":"5df8660924e03417008b4567","time":"33"}] | string | 设备列表 | Yes |
678   -
679   -
680   -| Code | Type | Model | Message |
681   -|-----|-----|-----|-----|
682   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {errcode: 0, result: "ok"} |
683   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
684   -
685   -
686   -
687   -<a name="updateline-post"></a>
688   -
689   -#### /UpdateLine (POST)
690   -
691   -
692   -更新线路
693   -
694   -| Code | Type | Model | Message |
695   -|-----|-----|-----|-----|
696   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | |
697   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
698   -
699   -
700   -
701   -<a name="updatescenic-post"></a>
702   -
703   -#### /UpdateScenic (POST)
704   -
705   -
706   -更新景区基础信息
707   -
708   -| Param Name | Example | Data Type | Description | Required? |
709   -|-----|-----|-----|-----|-----|
710   -| id | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
711   -
712   -
713   -| Code | Type | Model | Message |
714   -|-----|-----|-----|-----|
715   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称；Describe介绍；OpenHours营业时间；Picture最上面图片；ShopAdPicture商城列表页图片；ItemScenicPicture项目场次照片；ActivityPicture活动照片；VideoList视频(VideoPicture=首桢图片);InvestigationUrl问券调查的url；RangeLocation景区范围（多个坐标点） |
716   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
717   -
718   -
719   -
720   -<a name="updateuser-post"></a>
721   -
722   -#### /UpdateUser (POST)
723   -
724   -
725   -用户管理 - 修改用户信息
726   -
727   -| Param Name | Example | Data Type | Description | Required? |
728   -|-----|-----|-----|-----|-----|
729   -| id | aaron | string | 用户id | Yes |
730   -| Token | wgergejfwe | string | 用户token | Yes |
731   -| Birthday | 2010.10.10 | string | 生日 | Yes |
732   -| FullName | aarongao | string | 全名 | Yes |
733   -| Code | 12345678 | string | 6位验证码 | Yes |
734   -| Mobile | 18616619599 | string | 手机,同用户名 | Yes |
735   -| Sex | 男 | string | 性别 | Yes |
736   -| Openid | 12345 | string | 微信id | Yes |
737   -
738   -
739   -| Code | Type | Model | Message |
740   -|-----|-----|-----|-----|
741   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
742   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
743   -
744   -
745   -
746   -<a name="upload-post"></a>
747   -
748   -#### /Upload (POST)
749   -
750   -
751   -上传
752   -
753   -| Param Name | Example | Data Type | Description | Required? |
754   -|-----|-----|-----|-----|-----|
755   -| file | 1 | file | 文件 | Yes |
756   -
757   -
758   -| Code | Type | Model | Message |
759   -|-----|-----|-----|-----|
760   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"图片地址"} |
761   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
762   -
763   -
764   -
765   -<a name="userinfo-get"></a>
766   -
767   -#### /UserInfo (GET)
768   -
769   -
770   -用户管理 - 获取用户信息
771   -
772   -| Param Name | Example | Data Type | Description | Required? |
773   -|-----|-----|-----|-----|-----|
774   -| id | aaron | string | 用户id | Yes |
775   -| Token | wgergejfwe | string | 用户token | Yes |
776   -
777   -
778   -| Code | Type | Model | Message |
779   -|-----|-----|-----|-----|
780   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} |
781   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
782   -
783   -
784   -
785   -<a name="userlog-post"></a>
786   -
787   -#### /UserLog (POST)
788   -
789   -
790   -增加用户行为日志
791   -
792   -| Param Name | Example | Data Type | Description | Required? |
793   -|-----|-----|-----|-----|-----|
794   -| Type | 访问页面 | string | 安装;卸载;访问页面;使用功能;缩放地图;进入景区 | Yes |
795   -| SubType | 景区详情 | string | 推荐;景区详情;登陆;商城;投诉建议;问券调查....(app中能点的都加上) | Yes |
796   -| ScenicId | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes |
797   -| UserId | 5dfb03070a9ac17ac7a82054 | string | 用户ID | Yes |
798   -| UserName | Aaron | string | 用户名称 | Yes |
799   -| Location | {"Latitude": 119, "Longitude": 39} | string | 位置 | Yes |
800   -| Remarks | 备注 | string | 备注 | Yes |
801   -| Source | 用户分享 | string | 来源 | Yes |
802   -| DeviceId | abc123 | string | 手机唯一识别码,不重复(存放于http.header中) | Yes |
803   -| Mac | abc123 | string | 网卡Mac地址(存放于http.header中) | Yes |
804   -| SystemType | ios | string | ios,android(存放于http.header中) | Yes |
805   -| SystemVersion | 13.01 | string | 手机版本(存放于http.header中) | Yes |
806   -| SystemModel | iphone8 | string | 手机型号(存放于http.header中) | Yes |
807   -| AppVersion | 1.0 | string | app版本号(存放于http.header中) | Yes |
808   -| DeviceToken | abc | string | 推送token(存放于http.header中) | Yes |
809   -
810   -
811   -| Code | Type | Model | Message |
812   -|-----|-----|-----|-----|
813   -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":"ok"} |
814   -| 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} |
815   -
816   -