客户
# 概述
客户
类名
ClientApi.java
成员方法
名称 | 方法 | Method | Path |
---|---|---|---|
获取客户列表 | getClientList | POST | /api-organization/client/getClientList |
# 获取客户列表
ResultIPageCompanyClientVo getClientList(searchClientParam)
根据搜索内容与分页参数获取客户列表
# 请求参数
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
searchClientParam | SearchClientParam | searchClientParam |
# SearchClientParam
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
currentPage | Integer | 当前页 | |
keyword | String | 搜索内容 | - |
pageSize | Integer | 每页大小 |
# 返回参数
ResultIPageCompanyClientVo
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
code | String | 响应码 | - |
data | IPageCompanyClientVo | 响应数据 | - |
msg | String | 响应消息 | - |
time | OffsetDateTime | 响应时间 | - |
IPageCompanyClientVo
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
current | Long | - | |
hitCount | Boolean | - | |
pages | Long | - | |
records | List<CompanyClientVo> | - | |
searchCount | Boolean | - | |
size | Long | - | |
total | Long | - |
CompanyClientVo
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
address | String | 地址 | - |
adminId | String | 企业超级管理员id | - |
available | String | 可用(0:未审核,2:审核未通过,1或者空:可用) | - |
clientCompanyName | String | 客户企业名称 | - |
clientId | String | 客户id 实际也是企业id | - |
clientName | String | 客户名称 | - |
companyId | String | 企业id | - |
companyType | String | 客户的企业类型 | - |
contactEmail | String | 电子邮件 | - |
contactName | String | 联系人 | - |
contactPhone | String | 联系电话 | - |
createdBy | String | 创建人 | - |
createdTime | String | 创建时间 | - |
id | String | 主键 | - |
officePhone | String | 客户联系电话 | - |
remark | String | 备注 | - |
sex | String | 客户联系人性别 | - |
updatedTime | String | 修改时间 | - |
username | String | 客户管理员账号 | - |
# java-sdk 调用示例
//实例化api类,传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
SearchClientParam searchClientParam = new SearchClientParam();
try {
ResultIPageCompanyClientVo result = apiInstance.getClientList(searchClientParam);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用ClientApi.getClientList异常: " + e.getMessage());
e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# HTTP 调用示例
属性 | 名称 |
---|---|
HTTP请求地址 | http://[server]:[port]/api-organization/client/getClientList |
请求方式 | POST |
Content-Type | application/json |
header:key | Authorization |
header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"pageSize":0,
"currentPage":0,
"keyword":""
}
1
2
3
4
5
2
3
4
5