遍历用户

1. 请求地址：GET /users

2. 接口概述：

   遍历用户数据。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   offset	integer	响应结果起始下标	否	默认0
   limit	integer	响应结果的数量	否	默认50，最大1000

   如何遍历？

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/users HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 2184,
          "items": [
              {
                  "nickName": "nick_name",
                  "name": "login_name",
                  "guid": "xxxxx1",
                  "regDate": "2023-11-03 13:35:01",
                  "status": 0
              }
          ]
      }
   }

   响应体说明

查询用户

1. 请求地址： POST /users/data

2. 接口概述：

   根据指定条件查询用户。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   offset	integer	响应结果起始下标	否	默认0
   limit	integer	响应结果的数量	否	默认50，最大1000

   如何遍历？

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   querys	array	查询参数	否
   sorts	array	排序参数	否

   如何查询？

   querys

   支持：name。

   sorts

   支持：name。

   参数说明

5. 请求示例：

   POST /bitanswer/api/users HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "querys": [
          {
              "name": "name",
              "op": "like",
              "values": [
                  "nick_name%"
              ]
          }
      ],
      "sorts": [
          {
              "name": "name"
          }
      ]
   }

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 2,
          "items": [
              {
                  "nickName": "nick_name_1",
                  "name": "login_name_1",
                  "guid": "xxxxx1",
                  "regDate": "2023-11-03 13:35:01",
                  "status": 0
              },
              {
                  "nickName": "nick_name_2",
                  "name": "login_name_2",
                  "guid": "xxxxx2",
                  "regDate": "2023-11-07 17:59:12",
                  "status": 0
              }
          ]
      }
   }

   响应体说明

批量更新/添加用户

1. 请求地址：

   • PATCH /users
   • POST /users

2. 接口概述：

   使用帐号查找指定的用户，进行批量更新/添加用户。

   PATCH 方法根据帐号查找指定的用户，不存在则报错；存在则进行更新，仅更新输入的内容；

   POST 方法根据帐号查找指定的用户：若存在则进行更新用户，仅更新输入的内容；若不存在则添加用户，如果未设置用户名，则默认将用户名设为与帐号相同。

3. 请求参数：

   无

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   nickName	string	用户名	否
   name	string	帐号	是
   status	string	用户状态	否	状态：0：正常，1：禁用
   password	string	密码	否

   参数说明

   请求体以数组形式输入。

5. 请求示例：

   POST /bitanswer/api/users HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   [
      {
          "name":"login_name_1",
          "status": 1
      },
      {
          "name":"login_name_2",
          "password":"xxxxxx"
      }
   ]

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 2,
          "items": [
              {
                  "name": "login_name_1",
                  "status": 1
              },
              {
                  "name": "login_name_2",
                  "password": "xxxxxx"
              }
          ]
      }
   }

   响应体说明

批量删除用户

1. 请求地址：DELETE /users

2. 接口概述：

   批量删除用户。

3. 请求参数：

   无

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   name	string	用户的帐号	是

   请求体以数组形式输入。

5. 请求示例：

   DELETE /bitanswer/api/users HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   [
      {"name": "login_name_1"},
      {"name": "login_name_2"}
   ]

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "name": "login_name_1"
              },
              {
                  "name": "login_name_2"
              }
          ]
      }
   }

按帐号查询用户

1. 请求地址：GET /users/user/{name}

2. 接口概述：

   根据帐号查询指定用户。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   name	string	帐号	是

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/users/user/{name} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "nickName": "nick_name",
                  "name": "login_name",
                  "guid": "xxxxxx",
                  "regDate": "2024-01-19 15:33:09",
                  "status": 1
              }
          ]
      }
   }

   响应体说明

按帐号更新/添加用户

1. 请求地址：

   • PATCH /users/user/{name}

   • POST /users/user/{name}

2. 接口概述：

   使用帐号查找指定的用户，进行更新/添加用户。

   PATCH 方法根据帐号查找指定的用户，不存在则报错；存在则进行更新，仅更新输入的内容；

   POST 方法根据帐号查找指定的用户：若存在则进行更新用户，仅更新输入的内容；若不存在则添加用户，如果未设置用户名，则默认将用户名设为与帐号相同。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   name	string	帐号	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   nickName	string	用户名	否
   name	string	帐号	否	请求体若传name则需要与地址参数相同
   status	string	用户状态	否	状态：0：正常，1：禁用
   password	string	密码	否

   参数说明

5. 请求示例：

   PATCH /bitanswer/api/users/user/{name} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "name":"login_name",
      "nickName":"nick_name",
      "status": 1,
      "password":"xxxxxx"
   }

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "nickName": "nick_name",
                  "name": "login_name",
                  "guid": "xxxxx",
                  "regDate": "2024-01-19 15:33:09",
                  "status": 1
              }
          ]
      }
   }

   响应体说明

按帐号删除用户

1. 请求地址：DELETE /users/user/{name}

2. 接口概述：

   根据帐号删除指定用户。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   name	string	帐号	是

4. 请求体：

   无

5. 请求示例：

   DELETE /bitanswer/api/users/user/{name} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "name": "login_name"
              }
          ]
      }
   }

查询用户在线状态

1. 请求地址： GET /users/status

2. 接口概述：

   根据指定用户信息与在线状态。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   type	string	查询类型	否	查询类型：user，不区分大小写
   guid	string	用户的唯一标识符	否

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/users/status HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "type":"user",
      "guid":"xxxxx"
   }

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "nickName": "nick_name",
                  "name": "login_name",
                  "guid": "xxxxx",
                  "regDate": "2024-08-29 15:06:34",
                  "status": 2
              }
          ]
      }
   }

   响应体说明

   status表示用户状态：0：正常但未在线，1：禁用，2：用户在线

下线用户

1. 请求地址： POST /users/end

2. 接口概述：

   批量强制下线在线的用户。

3. 请求参数：

   无

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   type	string	查询类型	否	查询类型：user，不区分大小写
   guid	string	用户的唯一标识符	否

   请求体以数组形式输入。

5. 请求示例：

   POST /bitanswer/api/users/end HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   [
      {
          "type":"user",
          "guid":"xxxxx"
      }
   ]

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "nickName": "nick_name",
                  "name": "login_name",
                  "guid": "xxxxx",
                  "regDate": "2024-08-29 15:06:34",
                  "status": 0
              }
          ]
      }
   }

   响应体说明