# 示例
_日期：2017-09-20_
## 基本格式
1. 所有的url的params的value请求, 对于其中的中文都需要进行编码, 也就是**E4%B8%AD%E6%96%87**这样
的标准格式.
2. 对于日期类接口,会统一转换成**iso8601**格式也就是"2012-06-26T10:31:00+08:00"
3. 由于目前接口需要跨域使用,所以这里所有json接口都会提供**jsonp**支持. 回调为callback , 如果是 jquery
的话直接使用jsonp作为参数就可以了. 若无法使用jquery请参考jquery的jsonp接口实现就可以了.
## 接口说明
### 获取告警通知接口
`查询当前用户的告警通知信息`
#### 接口请求地址
`[URL_PREFIX]/home/show`
#### 请求地址示例
http://111.111.111.111:8080/home/show
####请求参数说明
参数名 | 参数说明
----- | -------------
topoId | 当前登录用户的授权区域ID
####返回参数说明
参数名 | 返回值类型 | 参数说明 |
----- | ------------- | ----------
exampleName | array | 示例名称
exampleName | Int | 示例名称
exampleName | String |示例名称
exampleName | String | 示例名称
exampleName | String |示例名称
exampleName | String |示例名称
exampleName | String |示例名称
exampleName | Int |示例名称
#### 返回值示例
```
{
"exampleName": [
{
"exampleName": 示例值,
"exampleName": "示例值 ",
"exampleName": "示例值 ",
"exampleName": "示例值 ",
"exampleName": "示例值 ",
"exampleName": "示例值 "
},
{
"exampleName": 值,
"exampleName": "值 ",
"exampleName": "值 ",
"exampleName": "值 ",
"exampleName": "值 ",
"exampleName": "值 "
}
],
"exampleName": 值
}
```
### 示例接口
`功能描述`
#### 接口请求地址
`[URL_PREFIX]/example/example`
#### 请求地址示例
http://111.111.111.111:8080/example/example/example
#### 请求参数说明
参数名 | 参数说明
----- | -------------
exampleName | 示例名称
#### 返回参数说明
参数名 | 返回值类型 | 参数说明 |
----------- | ------ | ----------
exampleName | String | 示例名称
exampleName | String | 示例名称
exampleName | String | 示例名称
exampleName | String | 示例名称
exampleName | Float | 示例名称
exampleName | Float | 示例名称
exampleName | String | 示例名称
#### 返回值示例
```
[
{
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值"
},
{
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值",
"exampleName": "示例值"
}
]
```
## 更新日志
时间 | 操作人 | 详情
----- | ----- | ----
2017-9-20 |luow | Markdown接口文档示例