3. 客户中台API

API列表

编号 API名称 路径 版本
3.1 获取客户列表 /mid/cust/query/list 1.0
3.2 获取客户信息 /mid/cust/query/info 1.0
3.3 创建客户 /mid/cust/create 1.0
3.4 更新客户信息 /mid/cust/update/info 1.0
3.5 更新客户数据状态 /mid/cust/update/state 1.0
3.6 更新客户审核状态 /mid/cust/update/submitStatus 1.0
3.7 获取客户信息列表 /mid/cust/info/query/list 1.0
3.8 获取客户房屋列表 /mid/cust/house/query/list 1.0
3.9 获取客户车辆列表 /mid/cust/car/query/list 1.0
3.10 获取客户车位列表 /mid/cust/carplace/query/list 1.0

API调用

3.1: 获取客户列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
custType BODY STRING 否 客户类型
userId BODY STRING 否 用户ID
custPhone BODY STRING 否 客户手机号
certiType BODY STRING 否 证件类型
certiNbr BODY STRING 否 证件号码
pageNo BODY INTEGER 否 当前页
pageSize BODY INTEGER 否 每页条数

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

{
  "projectId": "123456",
  "custType": "1001",
  "userId":"",
  "certiType":"",
  "certiNbr":"",
  "custPhone":"",
  "pageNo": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
customers data JSONArray 是 客户列表
custId customers STRING 是 客户ID
custName customers STRING 是 客户名
返回结果示例
{
    "code": 200,
    "data": {
        "total": 3474,
        "pages": 1737,
        "pageNo": 1,
        "pageSize": 2,
        "customers": [
            {
                "sex": null,
                "custId": 410001,
                "houses": [],
                "builds": [],
                "units": [],
                "custName": "吴美蓉",
                "custPhone": "xxx",
                "certiNbr": "xxxxx",
                "projectId": 610,
                "custStatus": 1
            },
            {
                "sex": 2,
                "custId": 410002,
                "houses": [],
                "builds": [],
                "units": [],
                "custName": "房产-江山项目公司",
                "custPhone": "xx",
                "certiNbr": null,
                "projectId": 610,
                "custStatus": 1
            }
        ]
    },
    "message": "success"
}

3.2: 获取客户信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/query/info

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
typeCode BODY STRING 否 客户类型
custId BODY STRING 是 客户ID

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

{
  "projectId": "123456",
  "typeCode": "01",
  "custId": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
customer data JSONObject 是 客户
custId data.customer STRING 是 客户ID
userId data.customer STRING 是 用户ID（当客户注册为用户时，回填该字段）
custName data.customer STRING 是 客户名
custPhone data.customer STRING 是 客户手机号
custStatus data.customer STRING 是 客户缴费状态（1正常，0异常）
custType data.customer STRING 是 客户类型
houses data ARRAY 是 房屋列表
builds data ARRAY 是 楼栋列表
units data ARRAY 是 单元列表
unitId data.units[] INTEGER 否 单元ID
buildId data.builds[] INTEGER 否 楼栋ID
houseId data.houses[] INTEGER 否 房屋ID
返回结果示例
{
    "code": 200,
    "data": {
        "houses": [
            {
                "floorId": 50281048,
                "houseId": 35330684,
                "name": "1栋_1单元_1001",
                "unitId": 50281047,
                "buildId": 50281046,
                "updateTime": "2019-08-03T14:31:53.000+0000",
                "floor": 1,
                "projectId": 21322229
            }
        ],
        "builds": [
            {
                "name": "1栋",
                "buildId": 50281046,
                "updateTime": "2019-01-22T06:30:48.000+0000",
                "projectId": 21322229
            }
        ],
        "units": [
            {
                "name": "1单元",
                "unitId": 50281047,
                "buildId": 50281046,
                "updateTime": "2019-01-22T06:30:58.000+0000",
                "projectId": 21322229
            }
        ],
        "customer": {
            "custId": 15755544,
            "custName": "陈先生",
            "custPhone": "18978346824",
            "certiNbr": "12345678901",
            "projectId": 21322229,
            "custStatus": 1
        }
    },
    "message": "success"
}

3.3: 创建客户

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/create

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
custName BODY STRING 是 客户名
custPhone BODY STRING 是 客户手机号
houseId BODY STRING 是 房屋ID
custType BODY STRING 是 客户类型
identity BODY STRING 否 身份证号
remark BODY STRING 否 备注
companyName BODY STRING 否 工作单位
companyAddres BODY STRING 否 工作单位地址
optUserId BODY STRING 否 操作用户ID
custGender BODY STRING 否 客户性别
organizationCode BODY STRING 否 组织机构代码
contactPerson BODY STRING 否 联系人
contactPhone BODY STRING 否 联系电话 
*添加客户资料接口,项目ID必填,客户电话和身份证号码不能同时为空,房屋ID不能为空

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

{
  "projectId": "123456",
  "custName":"",
  "custPhone":"",
  "houseId": "",
  "custType":"",
  "identity":"",
  "remark":"",
  "companyName":"",
  "companyAddres":"",
  "optUserId":"",
  "custGender":"",
  "organizationCode":"",
  "contactPerson":"",
  "contactPhone":""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
custId data STRING 是 客户ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      {
      "projectId": "123456",
      "typeCode": "01",
      "custName":"",
      "custPhone":"",
      "houseId": "",
      "custType":"",
      "identity":"",
      "remark":"",
      "companyName":"",
      "companyAddres":"",
      "optUserId":"",
      "custId":""
}
  }
}

3.4: 更新客户信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/update/info

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
typeCode BODY STRING 否 客户类型
custId BODY STRING 是 客户ID
custName BODY STRING 是 客户名
custPhone BODY STRING 是 客户手机号
houseId BODY STRING 是 房屋ID
custType BODY STRING 是 客户类型

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

{
  "projectId": "123456",
  "typeCode": "01",
  "custId":"",
  "custName":"",
  "custPhone":"",
  "houseId": "",
  "custType":""

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
customers data JSONArray 是 客户列表
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

3.5: 更新客户数据状态

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/update/state

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
typeCode BODY STRING 否 客户类型
custId BODY STRING 是 客户ID
status BODY STRING 是 状态

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

{
  "projectId": "123456",
  "typeCode": "01",
  "custId": "",
  "status": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

3.6: 更新客户审核状态

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/update/submitStatus

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
typeCode BODY STRING 否 客户类型
custId BODY STRING 是 客户ID
authFlag BODY STRING 是 审核状态

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

{
  "projectId": "123456",
  "typeCode": "01",
   "custId": "",
  "authFlag": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}
异常返回示例
{"code":"1301","message":""}

3.7: 获取客户信息列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/info/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
custName BODY STRING 否 客户名称
custPhone BODY STRING 否 客户手机号
certiType BODY STRING 否 证件类型
certiNbr BODY STRING 否 证件号码
pageNo BODY INTEGER 否 当前页
pageSize BODY INTEGER 否 每页条数
custType BODY INTEGER 否 客户类型
carPlateNo BODY STRING 否 车牌号码

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

{
  "projectId": "123456",
  "custType": "1001",
  "custPhone":"",
  "certiType":"",
  "certiNbr":"",
  "carPlateNo": "",
  "pageNo": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
customers data JSONArray 是 客户列表
custId customers STRING 是 客户ID
custName customers STRING 是 客户名
custClazzCode customers STRING 是 客户分类代号
custClazzName customers STRING 是 客户分类名称
custStatus customers STRING 是 客户缴费状态（1正常，0异常）
certiType customers STRING 是 证件类型
certiNbr customers STRING 是 证件号码
custPhone customers STRING 是 客户手机号
projectId customers INTEGER 是 项目ID
total data INTEGER 是 总条数
pages data INTEGER 是 总页数
pageNo data INTEGER 是 当前页
pageSize data INTEGER 是 每页条数
返回结果示例
{
    "code": 200,
    "data": {
        "total": 3474,
        "pages": 1737,
        "pageNo": 1,
        "pageSize": 2,
        "customers": [
            {
                "custId": 410001,
                "custName": "吴美蓉",
                "custClazzCode": "C",
                "custClazzName": "个人客户",
                "custStatus": 1,
                "certiType": "1",
                "certiNbr": "xxxx",
                "custPhone": "xxx",
                "projectId": 610,
            },
            {
                "custId": 410001,
                "custName": "xxx",
                "custClazzCode": "C",
                "custClazzName": "个人客户",
                "custStatus": 1,
                "certiType": "1",
                "certiNbr": "xxxx",
                "custPhone": "xxx",
                "projectId": 610,
            }
        ]
    },
    "message": "success"
}

3.8: 获取客户房屋列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/house/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
custId BODY ARRAY 否 客户ID
pageNo BODY INTEGER 否 当前页
pageSize BODY INTEGER 否 每页条数
unitId BODY INTEGER n 单元ID
buildId BODY INTEGER n 楼栋ID

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

{
  "projectId": "123456",
  "custId": ["1323432"],
  "pageNo": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
customers data JSONArray 是 客户列表
projectId customers STRING 是 项目ID
custId customers STRING 是 客户ID
houses customers JSONArray 是 客户名
custType houses STRING 是 客户类型
houseId houses STRING 是 房屋ID
houseNo houses STRING 是 房屋编号
houseName houses STRING 是 房屋名称
buildId houses STRING 是 楼栋ID
unitId houses STRING 是 单元ID
floor houses STRING 是 楼层
total data INTEGER 是 总条数
pages data INTEGER 是 总页数
pageNo data INTEGER 是 当前页
pageSize data INTEGER 是 每页条数
返回结果示例
{
    "code": 200,
    "data": {
        "total": 3474,
        "pages": 1737,
        "pageNo": 1,
        "pageSize": 2,
        "customers": [
            {
                "projectId": 610,
                "custId": 410001,
                "houses": [
                    {
                        "custType": "C4000",
                        "houseId": 278146,
                        "houseNo": "2501",
                        "houseName": "12栋_1单元_2501",
                        "buildId": 5207,
                        "unitId": 8291,
                        "floor": 25
                    }
                ]
            }
        ]
    },
    "message": "success"
}

3.9: 获取客户车辆列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/car/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
custId BODY STRING 否 客户ID
pageNo BODY INTEGER 否 当前页
pageSize BODY INTEGER 否 每页条数

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

{
  "projectId": "123456",
  "custId": "1323432",
  "pageNo": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
cars data JSONArray 是 车位列表
projectId cars STRING 是 项目ID
custId cars STRING 是 客户ID
carId cars STRING 否 车辆ID
carPlateNo cars STRING 否 车牌号码
total data INTEGER 是 总条数
pages data INTEGER 是 总页数
pageNo data INTEGER 是 当前页
pageSize data INTEGER 是 每页条数
返回结果示例
{
    "code": 200,
    "data": {
        "total": 3474,
        "pages": 1737,
        "pageNo": 1,
        "pageSize": 2,
        "cars": [
            {
                "projectId": "",
                "custId": "",
                "carId": "",
                "carPlateNo": ""
            }
        ]
    },
    "message": "success"
}

3.10: 获取客户车位列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/cust/carplace/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
custId BODY STRING 否 客户ID
pageNo BODY INTEGER 否 当前页
pageSize BODY INTEGER 否 每页条数

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

{
  "projectId": "123456",
  "custId": "1323432",
  "pageNo": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
places data JSONArray 是 车位列表
projectId parkings STRING 是 项目ID
custId parkings STRING 是 客户ID
parkinglotId parkings STRING 否 停车场ID
parkinglotNo parkings STRING 否 停车场编号
parkinglotName parkings STRING 否 停车场名称
areaId parkings STRING 否 停车区域ID
areaNo parkings STRING 否 停车区域编号
areaName parkings STRING 否 停车区域名称
parkingSpaceId parkings STRING 否 停车位ID
parkingSpaceNo parkings STRING 否 停车位编号
total data INTEGER 是 总条数
pages data INTEGER 是 总页数
pageNo data INTEGER 是 当前页
pageSize data INTEGER 是 每页条数
返回结果示例
{
    "code": 200,
    "data": {
        "total": 3474,
        "pages": 1737,
        "pageNo": 1,
        "pageSize": 2,
        "places": [
            {
                "projectId": "",
                "custId": "",
                "parkinglotId": "",
                "parkinglotNo": "",
                "parkinglotName": "",
                "areaId": "",
                "areaNo": "",
                "areaName": "",
                "parkingSpaceId": "",
                "parkingSpaceNo": ""
                "parkingSpaceId": ""
            }
        ]
    },
    "message": "success"
}

错误码列表(1301-1399)

错误码 错误信息 描述
1301 the customer not exists 客户不存在
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""