Skip to main content

Remove API

移除帳戶列表

Endpoints​

# Endpoints
POST
/web/remove/org/page
# 移除機構帳戶分頁
POST
/web/remove/free/page
# 移除非機構帳戶分頁
GET
/web/remove/org/detail/{id}
# 機構帳戶詳情
GET
/web/remove/free/detail/{id}
# 非機構帳戶詳情
DELETE
/web/remove/restore/{id}
# 恢復用戶
DELETE
/web/remove/delete/{id}
# 確認移除

Remove org page​

移除機構帳戶分頁

Request (RemoveUserPageFilter)​

POST /web/remove/org/page
{
  "loginID": "chea",
  "pagination": {
    "page": 1,
    "size": 10
  },
  "sortings": [
    {
      "direction": "DESC",
      "property": "createdAt"
    }
  ]
}

Response (RemoveOrgUserPageResp)​

{
  "success": true,
  "message": "",
  "data": {
    "pagination": {
      "page": 1,
      "size": 10,
      "totalItems": 1,
      "totalPages": 1
    },
    "sortings": [
      {
        "direction": "DESC",
        "property": "createdAt"
      }
    ],
    "items": [
      {
        "id": "4bc3f5ed-7214-4c70-9131-c2adb8969a9d",
        "userId": "93bd81f4-b9c1-4f80-942c-76ec4f82214d",
        "username": "cheaper",
        "email": "cheaper@example.com",
        "phone": "67654321",
        "district": "九龍城",
        "reason": "我唔中意呢个APP",
        "createdRemoveAt": "2024-09-25",
        "userType": 2,
        "serviceNumber": "123456789"
      }
    ]
  }
}

Remove free page​

移除非機構帳戶分頁

Request (RemoveUserPageFilter)​

POST /web/remove/free/page
{
  "loginID": "chea",
  "pagination": {
    "page": 1,
    "size": 10
  },
  "sortings": [
    {
      "direction": "DESC",
      "property": "createdAt"
    }
  ]
}

Response (RemoveOrgUserPageResp)​

{
  "success": true,
  "message": "",
  "data": {
    "pagination": {
      "page": 1,
      "size": 10,
      "totalItems": 1,
      "totalPages": 1
    },
    "sortings": [
      {
        "direction": "DESC",
        "property": "createdAt"
      }
    ],
    "items": [
      {
        "id": "4bc3f5ed-7214-4c70-9131-c2adb8969a9d",
        "userId": "93bd81f4-b9c1-4f80-942c-76ec4f82214d",
        "username": "cheaper",
        "email": "cheaper@example.com",
        "phone": "67654321",
        "district": "九龍城",
        "reason": "我唔中意呢个APP",
        "createdRemoveAt": "2024-09-25",
        "userType": 2,
        "serviceNumber": "123456789"
      }
    ]
  }
}

Org page detail​

機構帳戶詳情

Request​

GET /web/remove/org/detail/{id}

Response (RemoveUserDetail)​

{
  "success": true,
  "message": "",
  "data": {
    "id": "4bc3f5ed-7214-4c70-9131-c2adb8969a9d",
    "userId": "93bd81f4-b9c1-4f80-942c-76ec4f82214d",
    "username": "cheaper",
    "email": "cheaper@example.com",
    "phone": "67654321",
    "district": "九龍城",
    "reason": "我唔中意呢个APP",
    "createdRemoveAt": "2024-09-25",
    "userType": 2,
    "serviceNumber": "123456789",
    "nickname": "千鹏"
  }
}

Free page detail​

非機構帳戶詳情

Request​

GET /web/remove/free/detail/{id}

Response (RemoveUserDetail)​

{
  "success": true,
  "message": "",
  "data": {
    "id": "4bc3f5ed-7214-4c70-9131-c2adb8969a9d",
    "userId": "93bd81f4-b9c1-4f80-942c-76ec4f82214d",
    "username": "cheaper",
    "email": "cheaper@example.com",
    "phone": "67654321",
    "district": "九龍城",
    "reason": "我唔中意呢个APP",
    "createdRemoveAt": "2024-09-25",
    "userType": 2,
    "serviceNumber": "123456789",
    "nickname": "千鹏"
  }
}

Restore user​

恢復用戶

Request​

GET /web/remove/restore/{id}

Response​

{
  "success": true,
  "message": "",
  "data": null
}

Restore user​

確認移除

Request​

GET /web/remove/delete/{id}

Response​

{
  "success": true,
  "message": "",
  "data": null
}

Resources​

RemoveUserPageFilter​

properties
  • loginID
    String
    required
    對【用戶名，電郵，手機號碼，暱稱】模糊匹配字符
  • pagination
    pagination
    required
    分頁參數
  • sortings
    sortings
    排序字段

RemoveOrgUserPageResp​

properties
  • pagination
    pagination
    required
    分頁參數
  • sortings
    sortings
    排序字段
  • id
    String
    required
    移除列表ID
  • userId
    String
    required
    用戶ID
  • username
    String
    required
    用戶名
  • email
    String
    required
    郵件地址
  • phone
    String
    required
    電話
  • district
    String
    required
    區域
  • reason
    String
    required
    移除原因
  • createdRemoveAt
    String
    required
    移除日期
  • userType
    int
    required
    用戶類型
  • serviceNumber
    String
    required
    服務編號

RemoveUserDetail​

properties
  • id
    String
    required
    移除列表ID
  • userId
    String
    required
    用戶ID
  • username
    String
    required
    用戶名
  • email
    String
    required
    郵件地址
  • phone
    String
    required
    電話
  • district
    String
    required
    區域
  • reason
    String
    required
    移除原因
  • createdRemoveAt
    String
    required
    移除日期
  • userType
    int
    required
    用戶類型
  • serviceNumber
    String
    required
    服務編號
  • nickname
    String
    required
    暱稱