接口说明
- 删除后,可以使用【部门或项目查询】接口对齐信息。在查询接口里,不会返回已被删除的信息。
- 删除操作不可逆,请确认业务需求后再执行,避免误操作。
基本信息
|
HTTP URL |
/river/BudgetCenter/del |
|---|---|
|
HTTP Method |
POST |
|
权限要求 |
|
请求头
|
参数名称 |
参数值 |
|---|---|
|
Content-Type |
application/json |
请求参数
|
字段名 |
字段说明 |
字段类型 |
必填 |
|
|---|---|---|---|---|
|
client_id |
应用唯一标识 |
string |
Y |
滴滴开放平台创建应用时,由平台分配的唯一标识,用于识别调用方身份 |
|
access_token |
接口调用授权凭证 |
string |
Y |
授权认证后获取的访问令牌,用于校验接口调用权限;授权认证方式参见【接口认证-授权认证】 |
|
company_id |
租户唯一标识 |
string |
Y |
滴滴企业版租户唯一 ID,代表当前操作的企业主体 |
|
timestamp |
当前时间戳 |
int |
Y |
当前时间戳,精确到秒级 |
|
sign |
签名 |
string |
Y |
根据规则生成的接口签名,用于校验请求合法性与完整性;生成方式参见【接口认证-授权认证】 |
|
type |
类型 |
int |
N |
枚举值数字: |
|
id |
需要删除的滴滴侧部门/项目id |
string |
N |
部门删除时,id或out_budget_id,至少需传入其中一组参数,作为唯一标识进行匹配 |
|
name |
需要删除的部门/项目名称 |
string |
N |
使用out_budget_id删除项目时,name项目需要一起提供 |
|
out_budget_id |
需要删除的部门/项目外部编号 |
string |
N |
合作方侧自定义的唯一标识 |
如果采用集团账户方案,并且配置了由【上级公司统一对接】(具体配置请咨询滴滴侧对接人),请求参数有如下变化:
新增参数:
|
字段名 |
字段名称 |
类型 |
是否必填 |
备注 |
|---|---|---|---|---|
|
belong_enterprise_name |
归属企业名称 |
string |
N |
company_id传集团公司ID时,可通过该字段确定处理哪个子公司的数据 |
|
taxpayer_no |
纳税人识别号 |
string |
N |
company_id传集团公司ID时,可通过该字段确定处理哪个子公司的数据 |
请求示例
curl -X POST -H "content-type:application/json" \
-d '{
"client_id":"client_id_test",
"access_token":"1e79178d3bfeb40be24404a3048f541f34dd6268",
"timestamp":1583484681,
"company_id":"12345678980",
"id":"1125904357323169",
"sign":"b517f48fcbe57a2d66dcefd560452da1"
}' \
https://api.es.xiaojukeji.com/river/BudgetCenter/del
响应参数
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
errno |
错误编码 |
string |
数字 0 表示成功,非0 表示失败 |
|
errmsg |
错误信息 |
string |
errno=0时为常量"SUCCESS",errno!=0时为错误信息 |
|
data |
返回数据 |
object |
null |
响应示例
{
"errno":0,
"errmsg":"success",
"data":null
}
错误码
|
错误码 |
错误码文案 |
错误原因以及处理方案 |
|---|---|---|
|
10001 |
timestamp 过期 |
原因:请求携带的时间戳超出有效时效,接口拒绝处理 |
|
10002 |
IP 不在白名单中,本次请求 IP: |
原因:发起请求的服务器 IP 未配置在滴滴接口白名单内,接口做了 IP 访问限制 |
|
10003 |
id, name, out_budget_id, third_out_id 不能同时为空 |
原因:删除操作中未传入任何定位目标数据的参数,缺少核心必要参数 |
|
10003 |
type 必填 |
原因:使用外部编码执行删除操作时,未传入 type 参数,存在必填项缺失 |
|
10003 |
type 只能为 1 或 2 |
原因:传入的 type 参数值无效,超出接口规定的 1、2 取值范围,不符合删除接口传值规则 |
|
10003 |
out_budget_id 和 name 必填 |
原因:删除项目时未传入 out_budget_id 和 name 参数,缺少项目删除的必要参数 |
|
10003 |
out_budget_id 和 name 不能同时为空 |
原因:删除项目时 out_budget_id 和 name 参数均未传入,缺少项目核心标识参数 |
|
10003 |
id 和 third_out_id 不能都为空 |
原因:删除操作中未传入滴滴侧ID,缺少定位待删除数据的标识 |
|
10003 |
参数错误 |
原因:请求传入的参数存在格式、值类型、必填项缺失等错误 |
|
19999 |
签名失败 |
原因:请求的 sign 签名值生成规则错误、参数拼接错误或密钥不一致,签名校验未通过 |
|
412 |
client_id 和 access_token 为必填项 |
原因:请求未传入 client_id 或 access_token,两个均为接口必填参数 |
|
415 |
不支持 http 协议 |
原因:使用了 HTTP 协议发起请求,接口仅支持 HTTPS 安全协议 |
|
50102 |
要删除的成本中心不存在 |
原因:删除请求中id或out_budget_id在滴滴侧系统无匹配数据 |
|
50102 |
数据删除失败 |
原因:滴滴侧系统内部未成功解析并获取到删除请求的参数,属于系统异常 |
|
50102 |
删除成本中心失败 (部门中或子部门中存在员工,请先删除或调整部门或子部门中的员工) |
原因:待删除部门 / 子部门下仍有员工未清理 |
|
50102 |
删除成本中心失败 (禁止删除根节点) |
原因:尝试删除系统根部门,违反删除规则 |
其他信息参见:通用错误解决方案
使用建议
-
前置核心校验(执行删除前必做)
- 员工校验:待删除部门 / 其子部门下不可存在员工,有员工需先通过【员工修改】接口调整到其他部门,或通过【员工删除】接口清理,否则返回 50102
- 根部门校验:系统根部门禁止删除,请勿对根部门发起删除请求,否则返回 50102
-
待删除的数据如何匹配:
-
优先级规则:滴滴侧
id优先级最高,传id时无需传其他标识参数 -
部门删除:仅支持「
id」或「out_budget_id」二选一,不可同时传,非id匹配需传type=1 -
项目删除:仅支持「
id」或「out_budget_id+name」二选一,不可仅传out_budget_id或仅传name,非id匹配需传type=2 -
有效性要求:所有标识参数必须传入滴滴侧 / 合作方侧有效值,无效值直接返回错误码 50102
-
版本记录
|
日期 |
更新内容 |
上线时间 |
|---|---|---|
|
2023.11.07 |
迁移文档 |
|
|
2023.11.10 |
请求增加name与out_budget_id使用方法 增加查询字段type |
2024.01.04 |
|
2026.04.07 |
更新文档字段描述 |
|