操作文档
2025-11-15
目录

客户

# 概述

客户API 当需要将项目给另一个企业或用户使用时，即可将对应的项目授权给某个企业客户或客户，授权项目时需限制操作那么可将对应客户给予相应的权限角色 该API只提供了获取客户列表

类名

ClientApi.java

成员方法

名称 方法 Method Path
增加企业客户 addClientByExistedCompany POST /api-organization/client/addClientByExistedCompany
增加个人用户 addClientByPersonalUser POST /api-organization/client/addClientByPersonalUser
批量移除授权项目 batchRemoveAuthorizationProject POST /api-organization/client/batchRemoveAuthorizationProject
获取客户列表 getClientList POST /api-organization/client/getClientList
获取个人用户列表 getPersonageClientList POST /api-organization/client/getPersonageClientList
移除授权项目 removeAuthorizationProject POST /api-organization/client/removeAuthorizationProject
授权项目 saveGrantProject POST /api-organization/client/saveGrantProject
移交项目给客户 transferProjectToClient POST /api-organization/client/transferProjectToClient
更改授权角色 updateAuthorizationRole POST /api-organization/client/updateAuthorizationRole

# 增加企业客户

ResultObject addClientByExistedCompany(addCompanyClientForm)

增加企业为企业客户

# 请求参数

名称 类型 描述 备注
addCompanyClientForm AddCompanyClientForm addCompanyClientForm

# AddCompanyClientForm

名称 类型 描述 备注
clientId String 企业客户的企业Id
contactEmail String 企业客户联系邮箱 -
contactName String 企业客户联系人名称 -
contactPhone String 企业客户联系电话 -
remark String 企业客户备注 -

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
AddCompanyClientForm addCompanyClientForm = new AddCompanyClientForm();

try {
    ResultObject result = apiInstance.addClientByExistedCompany(addCompanyClientForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.addClientByExistedCompany异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/addClientByExistedCompany
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"clientId":"",
	"contactEmail":"",
	"contactName":"",
	"remark":"",
	"contactPhone":""
}
1
2
3
4
5
6
7

# 增加个人用户

ResultObject addClientByPersonalUser(addClientForm)

增加个人用户

# 请求参数

名称 类型 描述 备注
addClientForm AddPersonalUserForm addClientForm

# AddPersonalUserForm

名称 类型 描述 备注
address String 用户地址 -
clientCompanyName String 用户昵称
contactEmail String 邮箱 -
contactPhone String 手机号 -
officePhone String 办公电话 -
password String 用户密码
phoneCode String 手机号验证码或邮箱验证码 -
remark String 用户备注 -
roleId String 角色ID
sex Integer 用户性别 -
username String 用户名

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
AddPersonalUserForm addClientForm = new AddPersonalUserForm();

try {
    ResultObject result = apiInstance.addClientByPersonalUser(addClientForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.addClientByPersonalUser异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/addClientByPersonalUser
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"password":"",
	"address":"",
	"clientCompanyName":"",
	"officePhone":"",
	"contactEmail":"",
	"roleId":"",
	"sex":0,
	"phoneCode":"",
	"remark":"",
	"contactPhone":"",
	"username":""
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# 批量移除授权项目

ResultObject batchRemoveAuthorizationProject(delAuthorizationForms)

取消对客户多个项目的授权

# 请求参数

名称 类型 描述 备注
delAuthorizationForms List<DelAuthorizationForm> 客户项目授权列表

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
List<DelAuthorizationForm> delAuthorizationForms = Arrays.asList(new DelAuthorizationForm());

try {
    ResultObject result = apiInstance.batchRemoveAuthorizationProject(delAuthorizationForms);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.batchRemoveAuthorizationProject异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/batchRemoveAuthorizationProject
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"delAuthorizationForms":[
		{
			"clientId":"",
			"projectId":""
		}
	]
}
1
2
3
4
5
6
7
8

# 获取客户列表

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 主键 -
officeEmail 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

# 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

# 获取个人用户列表

ResultIPageUserVo getPersonageClientList(searchClientParam)

根据搜索内容与分页参数获取个人用户列表

# 请求参数

名称 类型 描述 备注
searchClientParam SearchClientParam searchClientParam

# SearchClientParam

名称 类型 描述 备注
currentPage Integer 当前页 -
keyword String 搜索内容 -
pageSize Integer 每页大小 -

# 返回参数

ResultIPageUserVo

名称 类型 描述 备注
code String 响应码 -
data IPageUserVo 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

IPageUserVo

名称 类型 描述 备注
current Long -
hitCount Boolean -
pages Long -
records List<UserVo> -
searchCount Boolean -
size Long -
total Long -

UserVo

名称 类型 描述 备注
address String 地址 -
avatar String 头像地址 -
companyId String 企业id -
createdBy String 创建人 -
createdTime OffsetDateTime 创建时间 -
createdTimeTimestamp Long 创建时间-时间戳 -
departmentId String 部门标识 -
departmentName String 部门名称 -
email String 邮箱 -
enabled Boolean 是否启用:1是0否 -
id String 主键id -
nickname String 昵称 -
officePhone String 办公号码 -
phone String 手机号 -
remark String 备注 -
roleId String 角色id -
roleName String 角色name -
sex Integer 性别 0.男,1女,2未知 -
sid String 二次开发访问密钥 -
type Integer 类型 0超级管理员(super),1超级企业管理员2企业管理员,3企业用户,4部门管理员5部门用户 -
updatedTime OffsetDateTime 修改时间 -
updatedTimeTimestamp Long 修改时间-时间戳 -
username String 用户名 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
SearchClientParam searchClientParam = new SearchClientParam();

try {
    ResultIPageUserVo result = apiInstance.getPersonageClientList(searchClientParam);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.getPersonageClientList异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/getPersonageClientList
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"pageSize":0,
	"currentPage":0,
	"keyword":""
}
1
2
3
4
5

# 移除授权项目

ResultObject removeAuthorizationProject(clientId, projectId)

取消对客户某个项目的授权

# 请求参数

名称 类型 描述 备注
clientId String 客户企业id
projectId String 项目id

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
String clientId = "clientId_example";
String projectId = "projectId_example";

try {
    ResultObject result = apiInstance.removeAuthorizationProject(clientId, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.removeAuthorizationProject异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/removeAuthorizationProject
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"clientId":"",
	"projectId":""
}
1
2
3
4

# 授权项目

ResultObject saveGrantProject(saveGrantProjectForm)

保存对客户授权项目,可同时授权多个项目

# 请求参数

名称 类型 描述 备注
saveGrantProjectForm SaveGrantProjectForm saveGrantProjectForm

# SaveGrantProjectForm

名称 类型 描述 备注
clientId String 客户企业id
grantArr List<String> 授权字符串
maintenanceIds List<String> -
type Integer -

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
SaveGrantProjectForm saveGrantProjectForm = new SaveGrantProjectForm();

try {
    ResultObject result = apiInstance.saveGrantProject(saveGrantProjectForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.saveGrantProject异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/saveGrantProject
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"clientId":"",
	"type":0
}
1
2
3
4

# 移交项目给客户

ResultObject transferProjectToClient(clientId, projectId)

把项目移交到客户企业

# 请求参数

名称 类型 描述 备注
clientId String 客户企业ID
projectId String 项目ID

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
String clientId = "clientId_example";
String projectId = "projectId_example";

try {
    ResultObject result = apiInstance.transferProjectToClient(clientId, projectId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.transferProjectToClient异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/transferProjectToClient
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"clientId":"",
	"projectId":""
}
1
2
3
4

# 更改授权角色

ResultObject updateAuthorizationRole(form)

更改授权给客户某个项目的角色

# 请求参数

名称 类型 描述 备注
form AuthorizationRoleForm form

# AuthorizationRoleForm

名称 类型 描述 备注
clientId String 客户企业id
maintenanceIds List<String> 维保ID集合
projectId String 项目id
roleId String 角色id
type Integer 类型(0为部门ID、1用户ID)

# 返回参数

ResultObject

名称 类型 描述 备注
code String 响应码 -
data Object 响应数据 -
msg String 响应消息 -
time OffsetDateTime 响应时间 -

# java-sdk 调用示例

//实例化api类，传入token
ClientApi apiInstance = new ClientApi(token);
//实例化请求参数
AuthorizationRoleForm form = new AuthorizationRoleForm();

try {
    ResultObject result = apiInstance.updateAuthorizationRole(form);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用ClientApi.updateAuthorizationRole异常: " + e.getMessage());
    e.printStackTrace();
}
1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性 名称
HTTP请求地址 http://[server]:[port]/api-organization/client/updateAuthorizationRole
请求方式 POST
Content-Type application/json
header:key Authorization
header:value Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"clientId":"",
	"roleId":"",
	"type":0,
	"projectId":""
}
1
2
3
4
5
6
报表
变量收藏

← 变量收藏→

最近更新
01
401-使用说明
 02-07
02
DLT645串口
 02-02
03
英威腾IVC系列串口
 02-02
更多文章>
Copyright © 2021-2026 沪公网安备31011702891182号