1. app品检API

API列表 test

编号 API名称 路径 版本
1.0 新增客户(增加根据手机号查询客户接口，手机号集团唯一逻辑) /v1/iot/main/customer/phone-check 1.0
1.1 客户分页查询 /v1/iot/main/customer/houseAndCustomers 1.0
1.2 产权统计数据 /v1/iot/main/customer/house/relation/property/statistic/{type}/{code} 1.0
1.3 成员列表 /v1/iot/main/customer/house/relation/getMember 1.0
1.4 事务信息 /v1/workorder/admin/instance/pageByCustId 1.0
1.5 证件信息校验 /v1/iot/main/customer/validate-Identity 1.0

1.0: 新增客户(增加根据手机号查询客户接口，手机号集团唯一逻辑)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/main/customer/phone-check

方法：POST

请求参数

名称 位置 类型 必填 描述
customer_phone body String y 客户手机号
top_org_id body Long y 顶级业务组织

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

{
  "customer_phone" : "13893839292",
  "top_org_id":"21897"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
id data Long 是 客户id
top_org_id data Long 是 顶级业务组织id
top_org_code data String 是 顶级业务组织code
customer_properties data int 是 客户性质 1:个人客户；2:政企客户
identity_type data String 是 证件类型, 1:身份证, 2:护照,3:组织机构代码(针对政府), 4:统一社会信用代码(针对企业),5:香港身份证,6:澳门身份证,7:台湾身份证
identity data String 是 证件id
customer_name data String 是 客户名
sex data int 是 性别，1:女，2:男
customer_phone data String 是 手机号
face_ico data DateTime 是 头像url
src data int 是 帐号来源，1：自研系统,2:4A
cust_birthday data String 是 生日
blood_type data string 是 血型:A/B/AB/O
occupation data String 是 职业:10字以内
graduated data String 是 毕业学校
relationOrgList data String[] N 归属组织
label data int[] 否 业主标签：1:公司员工、2:五星业主、3:残障人士、4:重点客户、5:政府机关人员、6：媒体名人、7：独居老人、8：业委会成员、9：中共党员
height data int 否 体重:填写数字
marry_status data int 否 婚姻状况：1:已婚，2:未婚
education_status data int 否 教育程度,1:小学、2:初中, 3:高中, 4:大专,5:本科 6:硕士研究生,7:博士研究生
live_status data int 否 居住情况， 1:独居 , 2:和家人同住
policy_status data int 否 政治面貌, 1:共青团员, 2:共产党员,3:预备党员,4: 群众, 5: 无党派人士,6: 九三学社社员, 7: 民盟盟员, 8: 民进会员, 9:致公党党员,10:民革党员,11:台盟盟员, 12:民建会员,13:农工党党员
contact data String 否 联系方式
email data String 否 邮件
返回结果示例
{
    "code": "200",
    "data": {
                    "update_by": "路人甲1",
                    "update_by_id": "21770",
                    "id": 113091,
                    "top_org_id": 21897,
                    "top_org_code": "100000150",
                    "customer_properties": 1,
                    "identity_type": 1,
                    "identity": "787877198809092323",
                    "customer_name": "五一",
                    "sex": 1,
                    "customer_phone": "13490908989",
                    "face_ico": "",
                    "status": 0,
                    "src": 1,
                    "cust_native": "AGADGDASG",
                    "cust_live_city": "ASGAG",
                    "cust_birthday": "1988-09-09",
                    "cust_nation": "汉族",
                    "cust_urgent_contact": "AGSA",
                    "relationOrgList": [],
                    "needReturnUserId": false,
                    "height": 166,
                    "blood_type": "O",
                    "weight": 66,
                    "occupation": "二位",
                    "label": "[1]",
                    "marry_status": 1,
                    "education_status": 1,
                    "live_status": 1,
                    "policy_status": 1,
                    "graduated": "ADGAF ",
                    "contact": "13567893434",
                    "email": "sdahfsd@midea.com"
                },
    "message": "成功"
}

1.1: 客户分页查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/main/customer/houseAndCustomers

方法：POST

请求参数

名称 位置 类型 必填 描述
pageNo body int y 页码
pageSize body int y 页大小
org_code body String y 小区code
space_code body String N 空间code
customer_type body int[] N 客户类型(2业主，3业主成员，14租户，15租户成员)
identity_type body int[] N 证件类型, 1:身份证, 2:护照,3:组织机构代码(针对政府), 4:统一社会信用代码(针对企业),5:香港身份证,6:澳门身份证,7:台湾身份证
searchCondition body String N 查询条件

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

{ 
  "pageNo": 1,
  "pageSize": 10,
  "space_code": "100001027100000000100000000100000000",
  "customer_type": [1,2, 3, 4,5],
  "identity_type": [1,2, 3, 4,5],
  "searchCondition": "1",
  "org_code": "100000150"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
total data int 是 记录总数
pageNo data int 是 页码
totalPage data int 是 总页数
pageSize data int 是 页大小
result data JSONArray 是 数据
id result long 是 客户id
customer_name result String 是 客户名字
customer_phone result String 是 客户手机号
identity result int 是 证件号
identity_type result String 是 证件类型
identity_type_trans result String 是 证件类型名字
space_name result String 是 空间名字
sex result int 是 1.男 2 女
sex_trans result String 是 男女
customer_properties data int 是 客户性质 1:个人客户；2:政企客户
customer_properties_trans result String 是 个人客户、政企客户
customer_type result int 是 客户类型(2业主，3业主成员，14租户，15租户成员)
customer_type_trans result String 是 业主，业主成员，租户，租户成员
type result int 是 产权类型
type_trans result String 是 产权类型名称
is_history result int 是 是否历史客户
housing_status result String 是 客户住房状态(1000在住，1001暂离，1003注销 ，1004迁出)
返回结果示例
{
    "code": "200",
    "message": "success"，
    "data": {
        "total": 448,
        "pageNo": 1,
        "totalPage": 45,
        "pageSize": 10
        "result": [
            {
                "id": 270901,
                "customer_name": "廖11",
                "customer_phone": "13632389675",
                "identity": "440928199902234216",
                "space_name": "领贤公馆/领片区/建筑物/1栋/A单元/1/102",
                "sex": 2,
                "identity_type": 1,
                "customer_properties": 1,
                "type": 1,
                "is_history": 1,
                "housing_status": 1004,
                "customer_type": 14,
                "sex_trans": "男",
                "identity_type_trans": "身份证",
                "customer_properties_trans": "个人客户",
                "type_trans": "房屋",
                "customer_type_trans": "未知"
            }
        ]

    }

}

1.2: 产权统计数据

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/main/customer/house/relation/property/statistic/{type}/{code}

方法：POST

请求参数

名称 位置 类型 必填 描述
type int y org / community
id int y 小区id

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

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

| owner | data | JSONObject | 是 | 业主 | | ownerMember | data | JSONObject | 是 | 主业成员 | | tenement | data | JSONObject | 是 | 租户 | | tenementMember | data | JSONObject | 是 | 租户成员 |

返回结果示例
{
    "code": "200",
    "message": "success",
    "data": {
        "owner": 122,
        "ownerMember": 137,
        "tenement": 120,
        "tenementMember": 0
    }
}

1.3: 成员列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/main/customer/house/relation/getMember

方法：POST

请求参数

名称 位置 类型 必填 描述
pageNo body int y 页码
pageSize body int y 页大小
customer_id body Long y 客户id

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

{
    "customer_id": "271224" , 
    "pageSize": 10 , 
    "pageNo": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
total data int 是 记录总数
pageNo data int 是 页码
totalPage data int 是 总页数
pageSize data int 是 页大小
result data JSONArray 是 数据
community_Id result long 是 小区id
community_name result String 是 小区名字
community_code result String 是 小区code
full_space_name result String 是 产权名字
customer_type result long 是 客户类型(2业主，3业主成员，14租户，15租户成员)
update_time result Date 是 更新时间
customer_name result String 是 客户名字
customer_id result long 是 客户id
返回结果示例
{
    "code": "200",
    "message": "success"
    "data": {
        "result": [
            {
                "community_name": "领贤公馆",
                "community_id": 21906,
                "community_code": "100001027",
                "full_space_name": "领贤公馆/通行专用片区/建筑物/60栋/1单元/1/102",
                "customer_type": 14,
                "update_time": "2022-07-18 11:40:22",
                "customer_name": null,
                "customer_id": 271521
            },
            {
                "community_name": "领贤公馆",
                "community_id": 21906,
                "community_code": "100001027",
                "full_space_name": "领贤公馆/通行专用片区/建筑物/60栋/1单元/1/101",
                "customer_type": 15,
                "update_time": "2022-07-16 14:17:17",
                "customer_name": null,
                "customer_id": 271201
            },
            {
                "community_name": "领贤公馆",
                "community_id": 21906,
                "community_code": "100001027",
                "full_space_name": "领贤公馆/通行专用片区/建筑物/60栋/1单元/1/102",
                "customer_type": 3,
                "update_time": "2022-07-16 15:03:05",
                "customer_name": "视声四",
                "customer_id": 271201
            },
            {
                "community_name": "领贤公馆",
                "community_id": 21906,
                "community_code": "100001027",
                "full_space_name": "领贤公馆/通行专用片区/建筑物/60栋/1单元/1/101",
                "customer_type": 14,
                "update_time": "2022-07-16 17:41:30",
                "customer_name": null,
                "customer_id": 271196
            },
            {
                "community_name": "领贤公馆",
                "community_id": 21906,
                "community_code": "100001027",
                "full_space_name": "领贤公馆/通行专用片区/建筑物/60栋/1单元/1/102",
                "customer_type": 2,
                "update_time": "2022-07-16 15:03:05",
                "customer_name": "视声三",
                "customer_id": 271196
            },
            {
                "community_name": "领贤公馆",
                "community_id": 21906,
                "community_code": "100001027",
                "full_space_name": "领贤公馆/通行专用片区/建筑物/60栋/1单元/1/102",
                "customer_type": 14,
                "update_time": "2022-07-16 18:17:00",
                "customer_name": null,
                "customer_id": 271191
            },
            {
                "community_name": "领贤公馆",
                "community_id": 21906,
                "community_code": "100001027",
                "full_space_name": "领贤公馆/通行专用片区/建筑物/60栋/1单元/1/101",
                "customer_type": 2,
                "update_time": "2022-07-16 15:05:16",
                "customer_name": "视声一",
                "customer_id": 271189
            },
            {
                "community_name": "美的领贤公馆",
                "community_id": 261644,
                "community_code": "100008084",
                "full_space_name": "美的领贤公馆/建筑物/1栋/1单元/1/103",
                "customer_type": 3,
                "update_time": "2022-07-16 14:53:52",
                "customer_name": "视声一",
                "customer_id": 271189
            },
            {
                "community_name": "美的领贤公馆",
                "community_id": 261644,
                "community_code": "100008084",
                "full_space_name": "美的领贤公馆/建筑物/1栋/1单元/1/103",
                "customer_type": 2,
                "update_time": "2022-07-16 14:53:52",
                "customer_name": "车行租01",
                "customer_id": 270573
            },
            {
                "community_name": "美的领贤公馆",
                "community_id": 261644,
                "community_code": "100008084",
                "full_space_name": "美的领贤公馆/建筑物/1栋/1单元/1/103",
                "customer_type": 2,
                "update_time": "2022-07-16 14:53:52",
                "customer_name": "关二波",
                "customer_id": 270184
            }
        ],
        "total": 10,
        "pageNo": 1,
        "totalPage": 1,
        "pageSize": 10
    }
}

1.4: 事务信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workorder/admin/instance/pageByCustId

方法：POST

请求参数

名称 位置 类型 必填 描述
pageNo body int y 页码
pageSize body int y 页大小
customerId body Long y 客户id

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

{
    "customerId": "271224" , 
    "pageSize": 10 , 
    "pageNo": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
total data int 是 记录总数
current data int 是 页码
pages data int 是 总页数
size data int 是 页大小
records data JSONArray 是 数据
orderNo records long 是 工单号
submitTime records String 是 提交时间
orderCategoryName records String 是 工单类型
title records String 是 工单题目
description records long 是 工单描述
spaceId records Date 是 小区id
spaceName records String 是 小区名
address records long 是 地址
返回结果示例
{
    "message": "Ok",
    "code": 200,
    "data": {
        "records": [
            {
                "orderNo": "111",
                "submitTime": "2022-01-17 11:40:44",
                "orderCategoryName": "",
                "orderCategoryId": 0,
                "title": "杰发的测试数据",
                "description": "待办测试",
                "spaceId": 98102,
                "topOrgId": null,
                "spaceName": "美的新海岸",
                "address": "三期/10栋/1单元/2002"
            },
            {
                "orderNo": "GD123456",
                "submitTime": "2022-01-17 11:40:44",
                "orderCategoryName": "",
                "orderCategoryId": 0,
                "title": "标题",
                "description": "工单描述",
                "spaceId": 98102,
                "topOrgId": null,
                "spaceName": "美的新海岸",
                "address": "三期/10栋/1单元/2002"
            }
        ],
        "total": 2,
        "size": 10,
        "current": 1, 
        "searchCount": true,
        "pages": 1
    }
}

1.5: 证件信息校验

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/main/customer/validate-identity

方法：POST

请求参数

名称 位置 类型 必填 描述
customer_identity body String y 证件id
identity_type body int y 证件类型
top_org_id body Long y 顶层业务组织id

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

{
    "customer_identity": "271224" , 
    "identity_type": 1 , 
    "top_org_id": 11122
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识 200:不存在 ， 999已存在
message 顶层 STRING 是 证件号已存在 ， 证件号不存在
返回结果示例

`` "message": "证件号不存在", "code": 200 } ```

results matching ""

    No results matching ""