4. 客户API

API列表

编号 API名称
4.1 产权认证
4.2 小区列表
4.3 认证产权选择列表
4.4 我的产权审核列表
4.5 门禁开门
4.6 电梯控制
4.7 根据小区id获取门禁、电梯列表
4.8 根据手机号获取房屋信息
4.9 根据手机号和项目id获取产权列表
4.10 根据手机号查询是否有未注册时的邀请消息

HTTP协议：

HTTP,HTTPS

API调用

4.1:产权认证

描述

请求信息

URI：/mid/user/propertyauth/manual/auth

方法：POST

请求参数

名称 位置 类型 必填 描述
name BODY STRING 否 姓名，手动认证必填，被动认证为null；和customerId不可同时为空
identityType BODY STRING 是 认证身份。具体定义见《身份类型》
identity BODY STRING 否 身份证号，手动认证必填，被动认证为null；和customerId不可同时为空
contactPhone BODY STRING 是 联系方式
properties BODY ARRAY 是 产权数组
ownerName properties[] STRING 否 业主姓名
ownerPhone properties[] STRING 否 业主手机号
propertyType properties[] STRING 是 产权类型。具体定义见《产权类型》
communityId properties[] STRING 是 小区ID
houseId properties[] STRING 是 房屋ID
customerId properties[] Long 否 客户id，手动认证为null，被动认证必填；和（name和identity）不可同时为空
moveOutOtherUser BODY Boolean 否 是否迁出同一身份证其他用户的产权，默认时不迁出历史数据

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

{
  "name": "",
  "identity": ""，
  "contactPhone": "",
  "properties": [
      {
      "identityType": "",
          "propertyType": "",
          "communityId": "",
      "ownerName": "",
      "ownerPhone": "",
          "houseId": "",
          "customerId":"",

      }
  ]
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
"code":"200",
"message":"成功",
"result":{
"operateCode":"1999",
"operateMessage":"当前产权已被客户张**的188****1234认证，请确认是否继续，继续将迁出该手机号"
  }
}
这种返回需要前端弹出页面让用户二次确认，用户点击确认时，入参moveOutOtherUser传true4

{
  "code": 200,
  "message": "success",
  "data": {
  }
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

4.2:小区列表

描述

请求信息

URI：/mid/user/propertyauth/community/list

方法：POST

请求参数

名称 位置 类型 必填 描述

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
communities data ARRAY 是 小区列表
cityName data.communities[] STRING 是 城市名
name data.communities[] STRING 是 小区名称
communityId data.communities[] STRING 是 小区ID

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": {
    "communities":[
      {
        "cityName": "",
        "name": "",
        "communityId": ""
      }
    ]
  }
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

4.3:认证产权选择列表

描述

请求信息

URI：/mid/user/propertyauth/house/selectlist

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId param STRING 是 小区ID

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
zoneNames data ARRAY 否 片区集合
buildNames data ARRAY 是 楼栋集合
houses data ARRAY 是 房屋列表
houseId data.houses[] STRING 是 家庭ID
roomNo data.houses[] STRING 是 房间号
buildName data.houses[] STRING 是 楼栋名
unit data.houses[] STRING 是 单元号
floor data.houses[] STRING 是 楼层
zone data.houses[] STRING 否 片区

返回结果示例

有片区的结果：
{
    "code": 200,
    "data": {
        "zoneNames": [
            "北区",
            "南区"
        ],
        "buildNames": [
            "A",
            "A栋"
        ],
        "houses": [
            {
                "unit": "二单元",
                "buildName": "A",
                "houseId": 20718,
                "roomNo": "201",
                "floor": "2层",
                "zone": "北区"
            },
            {
                "unit": "二单元",
                "buildName": "A",
                "houseId": 20719,
                "roomNo": "202",
                "floor": "2层",
                "zone": "北区"
            }
        ]
    },
    "message": "success"
}

无片区的结果：
{
    "code": 200,
    "data": {
        "zoneNames": [],
        "buildNames": [
            "1"
        ],
        "houses": [
            {
                "unit": "1",
                "buildName": "1",
                "houseId": 20384,
                "roomNo": "101",
                "floor": "1层",
                "zone": null
            },
            {
                "unit": "1",
                "buildName": "1",
                "houseId": 20385,
                "roomNo": "102",
                "floor": "1层",
                "zone": null
            }
        ]
    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

4.4:我的产权审核列表

描述

请求信息

URI：/mid/user/propertyauth/myhouse/list

方法：POST

请求参数

名称 位置 类型 必填 描述
userId header STRING 是 用户ID

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
houses data ARRAY 是 房屋列表
houseName data.houses[] STRING 是 房屋名称
communityName data.houses[] STRING 是 小区名
propertyType data.houses[] STRING 是 产权类型
status data.houses[] STRING 是 审核状态：0 未申请认证、1已申请认证、2 审核不通过、3 迁出、4 认证成功
userName data.houses[] STRING 是 用户名
contactPhone data.houses[] STRING 是 联系电话
identityType data.houses[] STRING 是 身份类型
timestamp data.houses[] Long 是 时间戳
approvalType data.houses[] STRING 是 审核类型:1业主审核,2租户审核,3四格审核

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": {
    "houses":[
      {
        "houseName": "",
        "communityName": "",
        "propertyType": "", 
        "status": ""  
        "timestamp": 0
        "userName": "",
        "contactPhone": "",
        "identityType": "",
        "approvalType": ""
      }
    ]
  }
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

4.5:门禁开门

描述

请求信息

URI：/api/equipment/openDoor

方法：POST

请求参数

名称 位置 类型 必填 描述
doorCode param STRING 是 门禁ID
doorNo param STRING 是 门禁路数
communityId param STRING 是 小区ID
manufacturer param STRING 否 厂商类型

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

{

}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": {

  }
}

4.6:电梯控制

描述

请求信息

URI：/api/equipment/controlElevator

方法：POST

请求参数

名称 位置 类型 必填 描述
devNo param STRING 是 梯控ID
floor param STRING 是 楼层
communityId param STRING 是 小区ID
manufacturer param STRING 否 厂商类型

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

{

}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": {

  }
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

4.7:根据小区id获取门禁、电梯列表

描述

请求信息

URI：/api/equipment/getByCommunityId

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId param STRING 是 房屋ID

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
identity data.equipments[] STRING 是 设备身份标识：目前拓桥是(序列号¦路数)，其他(自定义编号¦路数)
category data.equipments[] STRING 是 类别。目前支持: 门禁(DOOR)，电梯(LIFT)
manufacturer data.equipments[] STRING 是 厂商
name data.equipments[] STRING 是 设备名

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": {
     "equipments": [{
         "identity": "10|01",
         "category": "",
         "manufacturer": "",
         "name": ""
     }]
  }
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

4.8:根据手机号获取房屋信息

描述

请求信息

URI：/mid/user/propertyauth/houselist/by/mobile

方法：POST

请求参数

名称 位置 类型 必填 描述
isRegister param INT 是 是否是注册时调用？ 0:非注册 1：注册
mobile param STRING 是 手机号

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
houses 顶层 ARRAY 是 房屋列表
customerName data.houses[] STRING 是 客户真实姓名
customerId data.houses[] Long 是 客户id
customerIdentity data.houses[] STRING 是 客户身份证号
customerPhone data.houses[] STRING 是 客户联系方式
communityName data.houses[] STRING 是 小区名
communityId data.houses[] STRING 是 小区ID
houseName data.houses[] STRING 是 房屋名
houseId data.houses[] STRING 是 房屋ID
propertyType data.houses[] STRING 是 产权类型
identityType data.houses[] STRING 是 认证身份。具体定义见《身份类型》

返回结果示例

{
    "code": 200,
    "data": {
        "houses": [
            {
                "houseName": "101",
                "customerIdentity": "430555199307280001",
                "customerPhone": "13088842180",
                "houseId": 16447,
                "identityType": 2,
                "propertyType": 1,
                "customerId": 20033,
                "communityName": "朱慧媛-小区空间1-勿动",
                "communityId": 16438,
                "customerName": "Cfgg"
            },
            {
                "houseName": "102",
                "customerIdentity": "430555199307280001",
                "customerPhone": "13088842180",
                "houseId": 16448,
                "identityType": 2,
                "propertyType": 1,
                "customerId": 20033,
                "communityName": "朱慧媛-小区空间1-勿动",
                "communityId": 16438,
                "customerName": "Cfgg"
            },
            {
                "houseName": "103",
                "customerIdentity": "430555199307280001",
                "customerPhone": "13088842180",
                "houseId": 16449,
                "identityType": 1,
                "propertyType": 1,
                "customerId": 20033,
                "communityName": "朱慧媛-小区空间1-勿动",
                "communityId": 16438,
                "customerName": "Cfgg"
            }
        ]
    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

4.9:根据手机号和项目id获取产权列表

描述

请求信息

URI：/mid/user/propertyauth/list/by/communityIdAndMobile

方法：POST

请求参数

名称 位置 类型 必填 描述
mobile header STRING 是 手机号
communityId header STRING 是 小区ID

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

{
    "mobile": "",
    "communityId": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
houses data ARRAY 是 房屋列表
houseName data.houses[] STRING 是 房屋名称
communityName data.houses[] STRING 是 小区名
propertyType data.houses[] STRING 是 产权类型
status data.houses[] STRING 是 审核状态：0 未申请认证、1已申请认证、2 审核不通过、3 迁出、4 认证成功
userName data.houses[] STRING 是 用户名
contactPhone data.houses[] STRING 是 联系电话
identityType data.houses[] STRING 是 身份类型
timestamp data.houses[] Long 是 时间戳
approvalType data.houses[] STRING 是 审核类型:1业主审核,2租户审核,3四格审核

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": {
    "houses":[
      {
        "houseName": "",
        "communityName": "",
        "propertyType": "", 
        "status": ""  
        "timestamp": 0
        "userName": "",
        "contactPhone": "",
        "identityType": "",
        "approvalType": ""
      }
    ]
  }
}

4.10:根据手机号查询是否有未注册时的邀请消息

描述

请求信息

URI：/v1/iot/app/propertyauth/send/invitation/msg

方法：POST

请求参数

名称 位置 类型 必填 描述
mobile JSONObject STRING 是 手机号
userId header STRING 是 用户id

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

{
    "mobile": "",

}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": null
}

results matching ""

    No results matching ""