# 企业API
# 注册租户
POST /v1/enterprises/register
应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。参见接入事项-应用身份认证接口
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| enterpriseRegistrationParam | EnterpriseRegistrationParam | Y | body | enterpriseRegistrationParam |
| indicated-e-code | string | N | header | 域权限应用身份请求，需要设置企业编码 |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultEnterpriseRegister | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/enterprises/register
Content-Type: application/json
{
"contactName" : "string", //联系人
"enterpriseAddress" : "string", //企业地址
"enterpriseMail" : "string", //企业邮箱
"isAllowManage" : "boolean", //是否允许域管理员或者平台管理员管理企业，默认为true
"shortName" : "string", //企业简称
"contactPhone" : "string", //联系电话
"enterpriseIntroduction" : "string", //企业简介
"enterpriseName" : "string", //企业名称
"enterpriseVersion" : "string" //企业版本
}
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "string", //租户编码（eCode）
"message" : "string" //当状态码不是200时，错误信息
}
# 注销租户
POST /v1/enterprises/delete
应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。参见接入事项-应用身份认证接口
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| eCode | string | Y | query | 企业eCode |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfstring | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/enterprises/delete?eCode={eCode}
Content-Type: application/json
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "string", //请求返回的数据
"message" : "string" //当状态码不是200时，错误信息
}
# 冻结租户
POST /v1/enterprises/freeze
应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。参见接入事项-应用身份认证接口
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| eCode | string | Y | query | 企业eCode |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfstring | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/enterprises/freeze?eCode={eCode}
Content-Type: application/json
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "string", //请求返回的数据
"message" : "string" //当状态码不是200时，错误信息
}
# 解冻租户
POST /v1/enterprises/unfreeze
应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。参见接入事项-应用身份认证接口
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| eCode | string | Y | query | 企业eCode |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfstring | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/enterprises/unfreeze?eCode={eCode}
Content-Type: application/json
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "string", //请求返回的数据
"message" : "string" //当状态码不是200时，错误信息
}