获取险种配置列表
获取飞书人事系统中社保公积金设置下的险种配置详细列表,包括险种名称、类型等信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/compensation/v1/social_insurances |
| HTTP Method | GET |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | corehr:compensation.insurance:read 获取社保公积金险种 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | social_insurance\[\] | 险种列表 |
└ id | string | 险种唯一ID |
└ name | i18n | 险种名称 |
└ zh_cn | string | 中文名称 |
└ en_us | string | 英文名称 |
└ insurance_type | string | 险种类型. social_insurance: 社保; provident_fund: 公积金 可选值有: - social_insurance: 社保 - provident_fund: 公积金 |
└ active | boolean | 启用状态,true:启用,false:停用; |
└ is_system | boolean | 是否为系统预置险种,true:预置险种,false:自定义险种 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "7207415762276992556",
"name": {
"zh_cn": "生育保险",
"en_us": "maternity insurance"
},
"insurance_type": "social_insurance",
"active": true,
"is_system": true
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 2290001 | server error | 服务端异常,请稍后重试。若问题持续,请联系技术支持 |
| 400 | 2290002 | param is invalid | 参数异常 |
