服务机构的接口及文档

kongdeqiang

2020-12-10 8b78fa91629b31e4af0216884df0bae730751310

 api.md

@@ -18,7 +18,7 @@
> 获取所有区域

###### URL
> /api/getAllArea
> /api/fwjg/getByPage

###### 支持格式
> JSON
@@ -29,29 +29,82 @@
###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|    |    ||                          |
|  pageNumber  |  是  |int|      分页页数                    |
|  pageSize  |  是  |int|      分页大小                   |
|  sort  |  否  |String|      排序字段                   |
|  order  |  否  |String|      排序方式 asc/desc                  |

###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
|   |    |   |
| total  |  int  |  返回分页结果数 |
| size  |  int  |  分页大小 |
| current  |  int  |  当前页数 |
| pages  |  int  |  总共页数 |
| success  |  boolean  |  是否成功 |
| code  |  int  |  返回code码 |
| result  |  object  |  返回结果 |
| name  |  String  |  名称 |
| pid  |  String  |  上级id |

###### 接口示例
``` java
{
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
    "success": true,
    "message": "success",
    "code": 200,
    "timestamp": 1607582573231,
    "result": {
        "records": [
            {
                "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"
            }
        ],
        "total": 7,
        "size": 10,
        "current": 1,
        "orders": [],
        "hitCount": false,
        "searchCount": true,
        "pages": 1
    }
}
``` 

<h3 id='2'>二、首页</h2>
<h4 id='2.1'>2.1获取区域津贴统计</h4>
<h3 id='2'>二、服务机构</h2>
<h4 id='2.1'>2.1根据区域id获取区域下所有机构和人员数量以及订单总数</h4>
###### 接口功能
> 根据区域名称获取津贴统计
> 根据区域id获取区域下所有机构和人员数量以及订单总数

###### URL
> /api/getAllArea
> /api/fwjg/getCountByAreaId

###### 支持格式
> JSON
@@ -62,18 +115,215 @@
###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|    |    ||                          |
|  areaId  |  是  |String |     区域id                    |

###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
|   |    |   |
| fwjgCount  |  Integer  |  服务机构总数 |
| fwPersonCount  |  Integer  |  服务人员总数 |
| orderCount  |  Integer  |  订单总数 |
| orderWatch  |  String  |  订单监控率 |

###### 接口示例
``` java
{
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
    "success": true,
    "message": "success",
    "code": 200,
    "timestamp": 1607587253794,
    "result": {
        "fwjgCount": 1,
        "fwPersonCount": 1,
        "orderCount": 2,
        "orderWatch": "100%"
    }
}
``` 
<h4 id='2.1'>2.1根据区域id获取区域下所有服务以及服务详情和订单人数</h4>
###### 接口功能
> 根据区域id获取区域下所有机构和人员数量以及订单总数

###### URL
> /api/fwjg/getFwnlByAreaId

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|  areaId  |  是  |String |     区域id                    |

###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| fuwuDetails  |  object  |  服务详情一级菜单 |
| fuwuDetailsList  |  list  |  服务详情二级菜单 |
###### 接口示例
``` java
{
    "success": true,
    "message": "success",
    "code": 200,
    "timestamp": 1607594225830,
    "result": [
        {
            "fuwuDetails": {
                "id": "1336969411080359936",
                "createBy": null,
                "createTime": "2020-12-10 17:42:02",
                "updateBy": null,
                "updateTime": null,
                "delFlag": 0,
                "areaId": "1336923302341513216",
                "orgFwId": "1336941016934125568",
                "pid": null,
                "name": "康复服务",
                "orderNumber": null
            },
            "fuwuDetailsList": [
                {
                    "id": "1336969601455624192",
                    "createBy": null,
                    "createTime": "2020-12-10 17:42:47",
                    "updateBy": null,
                    "updateTime": null,
                    "delFlag": 0,
                    "areaId": "1336923302341513216",
                    "orgFwId": "1336941016934125568",
                    "pid": "1336969411080359936",
                    "name": "功能训练",
                    "orderNumber": 1
                },
                {
                    "id": "1336969641251180544",
                    "createBy": null,
                    "createTime": "2020-12-10 17:42:56",
                    "updateBy": null,
                    "updateTime": null,
                    "delFlag": 0,
                    "areaId": "1336923302341513216",
                    "orgFwId": "1336941016934125568",
                    "pid": "1336969411080359936",
                    "name": "康复按摩",
                    "orderNumber": 0
                }
            ]
        },
        {
            "fuwuDetails": {
                "id": "1336969708104192000",
                "createBy": null,
                "createTime": "2020-12-10 17:43:12",
                "updateBy": null,
                "updateTime": null,
                "delFlag": 0,
                "areaId": "1336923302341513216",
                "orgFwId": "1336941016934125568",
                "pid": null,
                "name": "生活照料服务",
                "orderNumber": null
            },
            "fuwuDetailsList": [
                {
                    "id": "1336969818158534656",
                    "createBy": null,
                    "createTime": "2020-12-10 17:43:39",
                    "updateBy": null,
                    "updateTime": null,
                    "delFlag": 0,
                    "areaId": "1336923302341513216",
                    "orgFwId": "1336941016934125568",
                    "pid": "1336969708104192000",
                    "name": "喘息服务",
                    "orderNumber": 0
                }
            ]
        }
    ]
}
}
``` 
<h4 id='2.1'>2.3根据区域id和订单量查询服务机构排名情况</h4>
###### 接口功能
> 根据区域id和订单量查询服务机构排名情况

###### URL
> /api/fwjg/getFwjgOrderByOrderNumber

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|  areaId  |  是  |String |     区域id                    |

###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| records  |  list  |  服务机构list |
###### 接口示例
``` java


``` 
<h4 id='2.1'>2.3根据区域id和订单量查询服务机构排名情况</h4>
###### 接口功能
> 根据区域id和订单量查询实际服务排名情况

###### URL
> /api/fwjg/getFuwuDetailsOrderByOrderNumber

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|  areaId  |  是  |String |     区域id                    |

###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| records  |  list  |  服务详情list |
###### 接口示例
``` java

``` 
<h4 id='2.1'>2.4执行中订单</h4>
###### 接口功能
> 执行中订单

###### URL
> /api/fwjg/getOrder

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数
|参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|  areaId  |  是  |String |     区域id                    |

###### 返回字段
|返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
| count  |  int  |  执行中订单数量 |
| orderByExecuteList  |  list  |  执行中订单详情 |
###### 接口示例
``` java