10 便民信息API

API列表

编号 API名称
10.1 查询信息列表
10.2 查询便民信息
10.3 添加便民信息
10.4 修改便民信息
10.5 删除便民信息
10.6 查询信息类型列表
10.7 查询区域列表
10.8 导出便民信息列表
[查询所属项目列表] (已有API)

10.1: 查询信息列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/news/guideline/list

方法：POST

请求参数

名称 位置 类型 必填 描述
name BODY STRING 否 信息名称
communityId BODY LONG 否 项目id
guidelineTypeId BODY LONG 否 信息类型id
page BODY INTEGER 否 分页页数
size BODY INTEGER 否 每页数据数

请求Body描述(非Form表单数据)

{
    "name": "云朵之家",
    "communityId": 1,
    "guidelineTypeId": 1,
    "page":1,
    "size":1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
id DATA Long 是 序号
name DATA STRING 是 信息名称
guidelineTypeID DATA LONG 是 信息类型ID
guidelineTypeName DATA STRING 是 信息类型名称
description DATA STRING 是 便民信息描述
communityId DATA LONG 是 项目ID
communityName DATA STRING 是 项目名称
regionId DATA LONG 是 区域ID
address DATA STRING 是 地址
contactName DATA STRING 是 联系人
contactTel DATA STRING 是 联系电话
longitude DATA STRING 是 精度
latitude DATA STRING 是 纬度
createTime DATA STRING 是 创建时间
createBy DATA STRING 是 创建人
updateTime DATA STRING 是 修改时间
updateBy DATA STRING 是 修改人
current 顶层 INTEGER 是 当前页数
total 顶层 INTEGER 是 数据条数
pages 顶层 INTEGER 是 总页数
size 顶层 INTEGER 是 每页数量
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "current": 2,
  "total": 15,
  "pages": 3,
  "size": 5,
  "data":[{
            "id": 1,
            "name": "云朵之家",
            "guidelineTypeId": 1,
            "description": "xxxxx",
            "communityId": 1,
            "communityName": "智慧小區",
            "regionId": 101010,
            "address": "xxxx",
            "contactName": "张三",
            "contactTel": "123xxxxx",
            "longitude": "",
            "latitude": "",
            "createTime": "2019-09-02T12:27:58.000+0000",
            "createBy": "admin",
            "updateTime": "",
            "updateBy": "",
            "guidelineTypeName": "aaa"
   }]
}

异常返回示例

{"code":20001,"message":"暂无信息","data":{}}

10.2: 查询便民信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/news/guideline/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
id BODY LONG 是 序号

请求Body描述(非Form表单数据)

{
    "id": 35
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
id DATA Long 是 序号
name DATA STRING 是 信息名称
guidelineTypeID DATA LONG 是 信息类型ID
guidelineTypeName DATA STRING 是 信息类型名称
description DATA STRING 是 便民信息描述
communityId DATA LONG 是 项目ID
communityName DATA STRING 是 项目名称
regionId DATA LONG 是 区域ID
address DATA STRING 是 地址
contactName DATA STRING 是 联系人
contactTel DATA STRING 是 联系电话
longitude DATA STRING 是 精度
latitude DATA STRING 是 纬度
createTime DATA STRING 是 创建时间
createBy DATA STRING 是 创建人
updateTime DATA STRING 是 修改时间
updateBy DATA STRING 是 修改人
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息
districtId 顶层 LONG 是 市区域id
districtName 顶层 STRING 是 市区域名称
provinceId 顶层 LONG 是 省区域id
provinceName 顶层 STRING 是 省区域名称
cityId 顶层 LONG 是 区（城市）id
cityName 顶层 STRING 是 区（城市）名字

返回结果示例

json
{
  "code": 200,
  "message": "成功",
  "data":{
        "id": 35,
        "name": "353535",
        "guidelineTypeId": 3,
        "description": "xxxxx",
        "communityId": 21322147,
        "communityName": "美的广夏花园",
        "regionId": 101010,
        "address": "xxxx",
        "contactName": "张三",
        "contactTel": "123xxxxx",
        "longitude": "",
        "latitude": "",
        "createTime": "2019-09-05 10:08:09",
        "createBy": "",
        "updateTime": "",
        "updateBy": "",
        "guidelineTypeName": "快递"
    }，
    "districtName": "延吉市",
    "cityName": "延边朝鲜族自治州",
    "provinceName": "吉林省",
    "provinceRegionId": 100008,
    "districtRegionId": 101010,
    "cityRegionId": 100093
}

异常返回示例

{"code":20001,"message":"暂无信息","data":{}}

10.3: 添加便民信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/news/guideline/add

方法：POST

请求参数

名称 位置 类型 必填 描述
name BODY STRING 是 信息名称
guidelineTypeId BODY LONG 是 信息类型id
description BODY STRING 否 便民信息描述
communityId BODY LONG 是 项目id
communityName BODY STRING 是 项目名称
contactName BODY STRING 是 联系人
contactTel BODY STRING 是 联系电话
regionId BODY LONG 是 区域id
address BODY STRING 否 详细地址

请求Body描述(非Form表单数据)

{
    "name": "云朵之家",
    "guidelineTypeId": 1,
    "description": "xxxxx",
    "communityId": 1,
    "communityName": "枫林小区",
    "contactName": "张三",
    "contactTel": "123xxxxx",
    "regionId": 1,
    "address": "xxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

json{
  "code": 200,
  "message": "成功",
  "data": {}
}

异常返回示例

{"code":20002,"message":"添加失败","data":{}}

10.4: 修改便民信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/news/guideline/update

方法：POST

请求参数

名称 位置 类型 必填 描述
id BODY LONG 是 序号
name BODY STRING 否 信息名称
guidelineTypeId BODY LONG 否 信息类型id
description BODY STRING 否 便民信息描述
communityId BODY LONG 否 项目id
communityName BODY STRING 否 项目名称
contactName BODY STRING 否 联系人
contactTel BODY STRING 否 联系电话
regionId BODY LONG 否 区域id
address BODY STRING 否 详细地址

请求Body描述(非Form表单数据)

{
    "id": 1,
    "name": "云朵之家",
    "guidelineTypeId": 1,
    "description": "xxxxx",
    "communityId": 1,
    "communityName": "枫林小区",
    "contactName": "张三",
    "contactTel": "123xxxxx",
    "regionId": 1,
    "address": "xxxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

json{
  "code": 200,
  "message": "成功",
  "data": {}
}

异常返回示例

{"code":20003,"message":"修改失败","data":{}}

10.5: 删除便民信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/news/guideline/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
id BODY LONG 是 序号

请求Body描述(非Form表单数据)

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功",
  "data": {}
}

异常返回示例

{"code":20004,"message":"删除失败","data":{}}

10.6: 查询信息类型列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/news/guideline/type/list

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId BODY LONG 否 项目（小区）id

请求Body描述(非Form表单数据)

{
    "communityId":21322147
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
guidelineTypeId DATA LONG 是 类型id
guidelineTypeName DATA STRING 是 类型名称
qty DATA LONG 是 该小区该类型信息条数统计
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": "200",
  "message": "成功",
  "data":[
    {
              "guidelineTypeId": 1,
            "guidelineTypeName": "物业",
            "qty": 3
    }
  ]

}

异常返回示例

{"code":"20001","message":"暂无信息","data":{}}

10.7: 查询区域列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/news/guideline/region/list

方法：POST

请求参数

名称 位置 类型 必填 描述
level BODY INTEGER 是 层级:0级为省、1级为市、2级为区
parentRegionId BODY LONG 否 上一级区域id,-1表示顶级

请求Body描述(非Form表单数据)

{
    "level":1,
    "parentRegionId":1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
regionId DATA LONG 是 区域id
level DATA INTEGER 是 层级:0级为省、1级为市、2级为区
name DATA STRING 是 区域名称
parentRegionId DATA LONG 是 上一级区域id
status DATA INTEGER 是 0无效，1有效
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

json
{
    "code": 200,
    "message":"成功",
    "data": [
        {
            "regionId": 2,
            "level": 1,
            "name": "深圳市",
            "parentRegionId": 1,
            "status": 1
        }
    ]

}

异常返回示例

{"code":"20001","message":"暂无信息","data":{}}

10.8: 导出便民信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/report/csv/exportNewsGuidelineList

方法：GET

请求参数

名称 位置 类型 必填 描述
name BODY STRING 否 信息名称
communityId BODY LONG 否 项目ID
guidelineTypeId BODY LONG 否 便民类型ID

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

导出文件

异常返回示例

{"code":"20001","message":"暂无信息","data":{}}

错误码列表(20001-20999)

错误码 错误信息 描述
20001 No Information 暂无信息
20002 fail to add 添加失败
20003 fail to update 修改失败
20004 fail to remove 删除失败
公共错误码 -- 
所有API公用的错误码，请参照《 [状态码定义](pub/status.md) 》 |

results matching ""

    No results matching ""