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