企业
# 概述
企业
类名
CompanyApi.java
成员方法
| 名称 | 方法 | Method | Path |
|---|---|---|---|
| 查询企业基本信息 | getCompanyInfo | POST | /api-organization/company/getCompanyInfo |
| 修改企业基本信息 | updateCompanyInfo | POST | /api-organization/company/updateCompanyInfo |
# 查询企业基本信息
ResultCompany getCompanyInfo(keyword)
通过企业全称或者企业ID查询企业信息
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| keyword | String | 企业全称或企业ID | - |
# 返回参数
ResultCompany
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | Company | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
Company
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| alias | String | 别名 | - |
| areaCode | String | 区域code | - |
| available | String | 是否可用 | - |
| city | String | 城市 | - |
| companyAdmin | String | 企业超级管理员 | - |
| companyType | String | 企业类型0:超级企业,1:普通企业,2:个人企业 | - |
| country | String | 国家 | - |
| createdBy | String | 创建人 | - |
| createdTime | OffsetDateTime | 创建时间 | - |
| district | String | 区/县 | - |
| id | String | 企业id | - |
| industry | String | 行业 | - |
| locked | String | 是否锁定(0:未锁定 1:锁定 | - |
| name | String | 企业名称 | - |
| province | String | 省 | - |
| remark | String | 备注 | - |
| scale | String | 规模 | - |
| street | String | 街道 | - |
| updatedTime | OffsetDateTime | 最后修改时间 | - |
| website | String | 网址 | - |
| years | String | 年限 | - |
# java-sdk 调用示例
//实例化api类,传入token
CompanyApi apiInstance = new CompanyApi(token);
//实例化请求参数
String keyword = "keyword_example";
try {
ResultCompany result = apiInstance.getCompanyInfo(keyword);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用CompanyApi.getCompanyInfo异常: " + 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/company/getCompanyInfo |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"keyword":""
}
1
2
3
2
3
# 修改企业基本信息
ResultObject updateCompanyInfo(companyForm)
修改企业基本信息
# 请求参数
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| companyForm | CompanyForm | companyForm |
# CompanyForm
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| alias | String | 企业简称 | - |
| city | String | 市code编码 | - |
| country | String | 国家 | - |
| district | String | 区code编码 | - |
| industry | String | 主要行业 | - |
| name | String | 企业名称 | - |
| province | String | 省code编码 | - |
| scale | String | 公司规模 | - |
| street | String | 街道详情 | - |
| website | String | 公司网址 | - |
| years | String | 企业年限 | - |
# 返回参数
ResultObject
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| code | String | 响应码 | - |
| data | Object | 响应数据 | - |
| msg | String | 响应消息 | - |
| time | OffsetDateTime | 响应时间 | - |
# java-sdk 调用示例
//实例化api类,传入token
CompanyApi apiInstance = new CompanyApi(token);
//实例化请求参数
CompanyForm companyForm = new CompanyForm();
try {
ResultObject result = apiInstance.updateCompanyInfo(companyForm);
System.out.println(result);
} catch (ApiException e) {
System.err.println("调用CompanyApi.updateCompanyInfo异常: " + 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/company/updateCompanyInfo |
| 请求方式 | POST |
| Content-Type | application/json |
| header:key | Authorization |
| header:value | Bearer YOUR_ACCESS_TOKEN |
请求参数:
{
"country":"",
"website":"",
"province":"",
"city":"",
"street":"",
"district":"",
"name":"",
"alias":"",
"scale":"",
"industry":"",
"years":""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
