1
0
forked from erp-dev/erp
Files
erpnew/docs/api_v2_customer_employee_binding.md

2.2 KiB
Raw Blame History

客户员工绑定 API

接口说明

将指定员工添加到指定客户的可见员工列表中(Customer.visible_employees)。

接口信息

  • URL: /api/v2/customers/bind-employee/
  • 方法: POST
  • 认证: 需要登录Bearer Token

请求参数

参数名 类型 必填 说明
customer_name string 客户名称
employee_name string 员工姓名

请求示例

curl -X POST "http://your-domain/api/v2/customers/bind-employee/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "张三服装厂",
    "employee_name": "李四"
  }'

响应说明

成功响应201 Created

{
  "message": "成功将员工 \"李四\" 添加到客户 \"张三服装厂\" 的可见列表",
  "customer_id": 123,
  "customer_name": "张三服装厂",
  "employee_id": 456,
  "employee_name": "李四"
}

已存在响应200 OK

如果该员工已经在客户的可见列表中:

{
  "message": "员工 \"李四\" 已在客户 \"张三服装厂\" 的可见列表中",
  "customer_id": 123,
  "employee_id": 456
}

错误响应

未找到数据400 Bad Request

{
  "error": "未找到名为 \"李四\" 的员工"
}

{
  "error": "未找到名为 \"张三服装厂\" 的客户"
}

找到多条数据403 Forbidden

{
  "error": "找到多个名为 \"李四\" 的员工3 个),请使用更精确的标识"
}

{
  "error": "找到多个名为 \"张三服装厂\" 的客户2 个),请使用更精确的标识"
}

参数验证失败400 Bad Request

{
  "customer_name": ["该字段是必填项。"],
  "employee_name": ["该字段是必填项。"]
}

注意事项

  1. 该操作是幂等的:重复绑定同一对客户和员工不会报错,会返回 200 状态码
  2. 如果客户或员工名称不唯一,系统会返回 403 错误,建议在数据库中确保名称唯一性
  3. 绑定关系为多对多,一个客户可以有多个可见员工,一个员工也可以被多个客户可见