xuefei
2020-12-11 299918864d460132dfcb210007dfb9564be15f04
api.md
@@ -2,15 +2,23 @@
[1.通用](#1)  
     [ 1.1获取所有区域接口](#1.1)  
     [ 1.2获取全部补贴类型](#1.2)
 
[2.首页](#2)  
    [ 2.1获取区域津贴统计](#2.1)
[3.补贴](#3)
    [ 2.1获取区域津贴统计](#2.1)
    [ 2.2获取全部补贴类型](#1.2)
[3.补贴](#3)
     [ 3.1获取总统计数据](#3.1)
     [ 3.2年度月度统计数据](#3.2)
[4.服务对象](#4) 
[5.服务机构](#5)
[5.服务机构](#5)
    [ 5.1根据区域id获取区域下所有机构和人员数量以及订单总数](#5.1)
    [ 5.2根据区域id获取区域下所有服务以及服务详情和订单人数](#5.2)
    [ 5.3根据区域id和订单量查询服务机构排名情况](#5.3)
    [ 5.4根据区域id和订单量查询服务机构排名情况](#5.4)
    [ 5.5执行中订单](#5.4)
<h3 id='1'>一、通用</h2>
<h4 id='1.1'>1.1获取所有区域接口</h4>
@@ -18,7 +26,7 @@
> 获取所有区域
###### URL
> /api/fwjg/getByPage
> /api/common/getAllArea
###### 支持格式
> JSON
@@ -29,23 +37,119 @@
###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|  pageNumber  |  是  |int|      分页页数                    |
|  pageSize  |  是  |int|      分页大小                   |
|  sort  |  否  |String|      排序字段                   |
|  order  |  否  |String|      排序方式 asc/desc                  |
###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| name  |  String  |  名称 |
| pid  |  String  |  上级id |
###### 返回示例
``` java
{
    "success": true,
    "message": "success",
    "code": 200,
    "timestamp": 1607648233416,
    "result": [
        {
            "id": "1336922902628536320",
            "createBy": null,
            "createTime": "2020-12-10 14:37:13",
            "updateBy": null,
            "updateTime": null,
            "delFlag": 0,
            "name": "石家庄市",
            "pid": null
        },
        {
            "id": "1336923258360041472",
            "createBy": null,
            "createTime": "2020-12-10 14:38:38",
            "updateBy": null,
            "updateTime": null,
            "delFlag": 0,
            "name": "长安区",
            "pid": "1336922902628536320"
        },
        ...
    ]
}
```
<h4 id='1.2'>1.2获取全部补贴类型</h4>
###### 接口功能
> 获取全部补贴类型
###### URL
> /api/common/getAllSubsidyType
###### 支持格式
> JSON
###### HTTP请求方式
> GET
###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| index  |  int  |  type值 |
| name  |  String  |  名称 |
###### 返回示例
``` java
{
    "success": true,
    "message": "success",
    "code": 200,
    "timestamp": 1607648519602,
    "result": [
        {
            "index": 0,
            "name": "困难残疾生活补贴"
        },
        {
            "index": 1,
            "name": "重度残疾人生活补贴"
        },
        {
            "index": 2,
            "name": "高龄老人生活补贴"
        },
        {
            "index": 3,
            "name": "高龄老人生活津贴"
        },
        ...
    ]
}
```
<h3 id='3'>三、补贴</h2>
<h4 id='3.1'>3.1获取总统计数据</h4>
###### 接口功能
> 根据区域id和补贴类型获取总的统计数据
###### URL
> /api/subsidy/getTotalStatistics
###### 支持格式
> JSON
###### HTTP请求方式
> GET
###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|  areaId  |  否  |String |     区域id                    |
|  type  |  否  |Integer |     补贴类型                    |
###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| total  |  int  |  返回分页结果数 |
| size  |  int  |  分页大小 |
| current  |  int  |  当前页数 |
| pages  |  int  |  总共页数 |
| success  |  boolean  |  是否成功 |
| code  |  int  |  返回code码 |
| result  |  object  |  返回结果 |
| name  |  String  |  名称 |
| pid  |  String  |  上级id |
| totalPersonNum  |  int  |  获取补贴的总人数 |
| fwPersonCount  |  double  |  总金额 |
###### 接口示例
``` java
@@ -53,53 +157,64 @@
    "success": true,
    "message": "success",
    "code": 200,
    "timestamp": 1607582573231,
    "timestamp": 1607648976798,
    "result": {
        "records": [
        "totalPersonNum": 1,
        "totalMoney": 100
    }
}
```
<h4 id='3.2'>3.2年度月度统计数据</h4>
###### 接口功能
> 根据区域id和补贴类型获取年度月度统计数据
###### URL
> /api/subsidy/getStatistics
###### 支持格式
> JSON
###### HTTP请求方式
> GET
###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|  areaId  |  否  |String |     区域id                    |
|  type  |  否  |Integer |     补贴类型                    |
###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| monthStatistics  |  Objec  |  月度统计数据 |
| yearStatistics  |  Objec  |  年度统计数据 |
###### 接口示例
``` java
{
    "success": true,
    "message": "success",
    "code": 200,
    "timestamp": 1607649436415,
    "result": {
        "monthStatistics": [
            {
                "id": "1336922902628536320",
                "createBy": null,
                "createTime": "2020-12-10 14:37:13",
                "updateBy": null,
                "updateTime": null,
                "delFlag": 0,
                "name": "石家庄市",
                "pid": null
            },
            {
                "id": "1336923402568601600",
                "createBy": null,
                "createTime": "2020-12-10 14:39:12",
                "updateBy": null,
                "updateTime": null,
                "delFlag": 0,
                "name": "新华区",
                "pid": "1336922902628536320"
            },
            {
                "id": "1336923441189752832",
                "createBy": null,
                "createTime": "2020-12-10 14:39:21",
                "updateBy": null,
                "updateTime": null,
                "delFlag": 0,
                "name": "正定县",
                "pid": "1336922902628536320"
                "sum": 100,
                "time": "2020-12"
            }
        ],
        "total": 7,
        "size": 10,
        "current": 1,
        "orders": [],
        "hitCount": false,
        "searchCount": true,
        "pages": 1
        "yearStatistics": [
            {
                "sum": 100,
                "time": "2020"
            }
        ]
    }
}
``` 
<h3 id='2'>二、服务机构</h2>
<h4 id='2.1'>2.1根据区域id获取区域下所有机构和人员数量以及订单总数</h4>
<h3 id='5'>五、服务机构</h2>
<h4 id='5.1'>5.1根据区域id获取区域下所有机构和人员数量以及订单总数</h4>
###### 接口功能
> 根据区域id获取区域下所有机构和人员数量以及订单总数
@@ -140,7 +255,7 @@
    }
}
``` 
<h4 id='2.1'>2.1根据区域id获取区域下所有服务以及服务详情和订单人数</h4>
<h4 id='5.2'>5.2根据区域id获取区域下所有服务以及服务详情和订单人数</h4>
###### 接口功能
> 根据区域id获取区域下所有机构和人员数量以及订单总数
@@ -248,7 +363,7 @@
}
}
``` 
<h4 id='2.1'>2.3根据区域id和订单量查询服务机构排名情况</h4>
<h4 id='5.3'>5.3根据区域id和订单量查询服务机构排名情况</h4>
###### 接口功能
> 根据区域id和订单量查询服务机构排名情况
@@ -275,7 +390,7 @@
``` 
<h4 id='2.1'>2.3根据区域id和订单量查询服务机构排名情况</h4>
<h4 id='5.4'>5.4根据区域id和订单量查询服务机构排名情况</h4>
###### 接口功能
> 根据区域id和订单量查询实际服务排名情况
@@ -301,7 +416,7 @@
``` java
``` 
<h4 id='2.1'>2.4执行中订单</h4>
<h4 id='5.5'>5.5执行中订单</h4>
###### 接口功能
> 执行中订单