数据传输约定

本 OA 系统的 API 数据交换使用 JSON 格式，并使用 UTF-8 编码。如果你希望编写自己的前端，与系统的后端进行对接，请务必使用 JSON，并添加以下的 HTTP 头：

Content-Type: application/json;charset=utf-8

依照 API 不同，请求体具体要求也有差异。具体可以从接口列表中，查找相应接口的请求体要求。

服务器接收到请求后，会返回一些必要数据。如果服务器成功接受并处理了数据，将会返回 HTTP 200 错误，并附带一些数据：

{
  "status": "Success",
  "data":{
    ...
  }
}

如果请求失败，将会有以下类似的返回体：

{
  "status": "Fail",
  "code": "0",
  "description": "未登录至服务器。"
}

除了直接读取服务器返回的错误描述之外，你还可以根据 HTTP 错误码及返回体中的 code，判断具体的错误缘故。

不同的 HTTP 错误码所代表的错误类别如下：

• 200 OK：服务器正常获取数据、正常处理了请求，并且正常地返回了相应的数据。
• 400 Bad Request：用户传给系统的请求出现了错误。这个错误可能出在用户输入错误等情况。
• 401 Unauthorized：操作未授权。导致这个错误的原因可能是用户未登录，或当前登录用户没有使用相应接口的权限。
• 404 Not Found：找不到资源。通常出现在 GET 要求请求的接口中。当系统按照用户的指示请求相应资源时，系统没有在正确的位置找到对应的数据。
• 409 Conflict：系统需要更多信息来处理这个请求。
• 418 I'm a teapot：我是个茶壶，不能煮咖啡。
• 500 Internal Server Error：服务器出现异常错误，需要等待管理员进行修复。
• 503 Service Unavailable：服务器正在维护。

在本文档中，每个接口都有详细的错误描述和错误 code 列表。