更新文档,增加通知接口

aarongao
1 parent 5af620a9
Showing 1 changed file with 43 additions and 0 deletions Show diff stats
README.md
@@ -15,6 +15,8 @@
 1. [所有景区基础信息](#allscenic-get)
 1. [查询商品信息](#commodityinfo-get)
 1. [增加投诉](#createcomplaint-post)
+1. [查询用户的定时提醒](#dealymessage-info-get)
+1. [创建提醒](#dealymessage-create-post)
 1. [增加调查](#investigation-save-post)
 1. [查询设备信息](#iteminfo-get)
 1. [查询线路信息](#lineinfo-get)
@@ -155,6 +157,47 @@
  
  
  
+<a name="dealymessage-info-get"></a>
+
+#### /DealyMessage/Info (GET)
+
+
+查询用户的定时提醒
+
+| Param Name | Example | Data Type | Description | Required? |
+|-----|-----|-----|-----|-----|
+| UserId | 5dfb03070a9ac17ac7a82054    | string | 用户id | 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)
+
+
+创建提醒
+
+| Param Name | Example | Data Type | Description | Required? |
+|-----|-----|-----|-----|-----|
+| UserId | 5dfb03070a9ac17ac7a82054    | string | 用户id | Yes |
+| UDID | 5dfb03070a9ac17ac7a82054    | string | 设备id | Yes |
+| Title | 表演时间提醒    | string | 标题 | Yes |
+| Content | 5分钟后有表演    | string | 内容 | Yes |
+| DelayTime | 1579066863    | 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-save-post"></a>
  
 #### /Investigation/Save (POST)
...	...	@@ -15,6 +15,8 @@
15	15	1. [所有景区基础信息](#allscenic-get)
16	16	1. [查询商品信息](#commodityinfo-get)
17	17	1. [增加投诉](#createcomplaint-post)
	18	+1. [查询用户的定时提醒](#dealymessage-info-get)
	19	+1. [创建提醒](#dealymessage-create-post)
18	20	1. [增加调查](#investigation-save-post)
19	21	1. [查询设备信息](#iteminfo-get)
20	22	1. [查询线路信息](#lineinfo-get)
...	...	@@ -155,6 +157,47 @@
155	157
156	158
157	159
	160	+<a name="dealymessage-info-get"></a>
	161	+
	162	+#### /DealyMessage/Info (GET)
	163	+
	164	+
	165	+查询用户的定时提醒
	166	+
	167	+\| Param Name \| Example \| Data Type \| Description \| Required? \|
	168	+\|-----\|-----\|-----\|-----\|-----\|
	169	+\| UserId \| 5dfb03070a9ac17ac7a82054 \| string \| 用户id \| Yes \|
	170	+
	171	+
	172	+\| Code \| Type \| Model \| Message \|
	173	+\|-----\|-----\|-----\|-----\|
	174	+\| 200 \| object \| [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) \| DelayTime=执行时间;Type=类型(0请求url地址1发送app通知);Fail失败次数;Title=通知标题;Content=通知内容;UDID=设备id \|
	175	+\| 500 \| object \| [ResponseError](#github.com.aarongao.tools.ResponseError) \| {"errcode":1,"errmsg":"错误原因"} \|
	176	+
	177	+
	178	+<a name="dealymessage-create-post"></a>
	179	+
	180	+#### /DealyMessage/Create (POST)
	181	+
	182	+
	183	+创建提醒
	184	+
	185	+\| Param Name \| Example \| Data Type \| Description \| Required? \|
	186	+\|-----\|-----\|-----\|-----\|-----\|
	187	+\| UserId \| 5dfb03070a9ac17ac7a82054 \| string \| 用户id \| Yes \|
	188	+\| UDID \| 5dfb03070a9ac17ac7a82054 \| string \| 设备id \| Yes \|
	189	+\| Title \| 表演时间提醒 \| string \| 标题 \| Yes \|
	190	+\| Content \| 5分钟后有表演 \| string \| 内容 \| Yes \|
	191	+\| DelayTime \| 1579066863 \| string \| 到达这个时间戳就执行 \| 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":1,"errmsg":"错误原因"} \|
	198	+
	199	+
	200	+
158	201	<a name="investigation-save-post"></a>
159	202
160	203	#### /Investigation/Save (POST)
...	...