From e5fd5aeaa3b37f1996521bc025d7479426ce6af1 Mon Sep 17 00:00:00 2001 From: aarongao Date: Wed, 15 Jan 2020 14:09:23 +0800 Subject: [PATCH] 更新文档,增加通知接口 --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+), 0 deletions(-) diff --git a/README.md b/README.md index 5fd07a5..9afac3f 100644 --- a/README.md +++ b/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 @@ + + +#### /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":"错误原因"} | + + + + +#### /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":"错误原因"} | + + + #### /Investigation/Save (POST) -- libgit2 0.21.0