接口说明
版本号
v1.0.0
接口功能
查询客户信息。
请求方法
设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELETE等方法。
请求URL
参考示例:/rest/v1/queryCustomer
其中,v1为接口版本。
请求消息
此处仅提供客户侧接口示例,最终会通过API Fabric处理成前端展示所需字段。
- 消息头
Content-Type:application/json; charset=UTF-8,
Connection:keep-alive
- 消息体
该接口的请求消息体举例如下:
{
"param":"152****1028"
}
该接口的请求消息体参数说明如表 1 所示。
响应消息
该接口的响应消息体举例如下:
[
{
"objectName": "客户信息",
"values": [
{
"valueNo": "1",
"length": "128",
"type": "1",
"value": "zengxiangyu01",
"isMandatory": true,
"name": "姓名"
},
{
"valueNo": "2",
"dictItems": [
{
"value": "预付费",
"key": "1"
},
{
"value": "后付费",
"key": "2"
}
],
"type": "5",
"value": "1",
"isMandatory": true,
"name": "付费方式"
}]
}
]
该接口的响应消息体参数说明如表 2所示。
|
参数名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|
|
valueNo |
string |
False |
序号。 |
|
name |
string |
True |
属性名。 |
|
value |
object |
True |
属性值。 |
|
type |
string |
True |
类型。取值范围:
|
|
length |
string |
False |
长度。<=256字符。 |
|
isMandatory |
boolean |
True |
是否必填。 |
|
maskStyle |
string |
False |
掩码展示类型。取值范围:
空或不传正常展示 |
|
dictItems |
array |
False |
字典项。type为5时必填。详细参数说明请参见表4。 |
错误结果码
无。