{
  "module": {
    "module": "OpenAPI 接口",
    "moduleKey": "openapi"
  },
  "api": {
    "title": "职员管理 - 分页列表查询",
    "method": "GET",
    "path": "/openapi/staff/list",
    "description": "分页查询职员管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。",
    "requestParams": {
      "headers": [
        {
          "name": "X-Site",
          "type": "string",
          "required": true,
          "description": "站点标识（必填）"
        },
        {
          "name": "X-System-Code",
          "type": "string",
          "required": true,
          "description": "系统编码（必填）"
        },
        {
          "name": "X-Scope-Key",
          "type": "string",
          "required": true,
          "example": "550e8400-e29b-41d4-a716-446655440000",
          "description": "数据 scope 分区标识（UUID）。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区；有组织时默认使用组织 scope，无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。"
        }
      ],
      "query": [
        {
          "name": "pageNum",
          "type": "number",
          "required": false,
          "description": "页码，默认1"
        },
        {
          "name": "pageSize",
          "type": "number",
          "required": false,
          "description": "每页数量，默认10"
        },
        {
          "name": "name",
          "type": "string",
          "required": false,
          "description": "名称（模糊搜索）"
        },
        {
          "name": "code",
          "type": "string",
          "required": false,
          "description": "编码（模糊搜索）"
        }
      ]
    },
    "responseExample": {
      "success": {
        "code": "0000",
        "message": "查询成功",
        "data": {
          "list": [
            {
              "id": 1,
              "code": "STAFF0001",
              "name": "李四",
              "title": "技术部员工",
              "phone": "13700137000",
              "email": "lisi@example.com",
              "status": 1,
              "departmentId": "DEPT0001",
              "positionId": "POS0001",
              "createTime": "2025-01-01T10:00:00.000Z",
              "updateTime": "2025-01-01T10:00:00.000Z"
            }
          ],
          "total": 1,
          "pageNum": 1,
          "pageSize": 10
        }
      }
    },
    "notes": [
      "只返回状态为有效的记录（status=1）",
      "支持多种可选查询条件进行筛选",
      "必须提供有效的X-Site header，查询对应站点的数据",
      "必须提供有效的X-System-Code header，支持客户端系统",
      "必须提供有效的 X-Scope-Key header，仅返回该 scope 分区内的数据",
      "禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围"
    ]
  }
}