Skip to main content

Approval Process API

審批流程API向Web端提供申請、註銷計劃會員，以及加入變更地區的審批流程操作。

Endpoints​

# Endpoints
GET
/web/approval/{transferId}
# 獲取用戶申請的信息，包括申請、註銷計劃會員，加入退出中心信息
POST
/web/approval/page
# 獲取用戶申請的分頁信息
PUT
/web/approval/out-centre
# 審批退會申請
PUT
/web/approval/join-centre
# 審批入會申請
PUT
/web/approval/out-member
# 審批申請成為計劃會員
PUT
/web/approval/join-member
# 審批註銷成為計劃會員
POST
/web/approval/page-count
# 统计申请数量

Get user apply info​

獲取用戶申請的信息，包括申請、註銷計劃會員，加入退出中心信息。

Request​

GET /web/approval/{transferId}

Response (UserApprovalInfoDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "transferId": "18512c64-37c8-4d09-9cde-5aaf29465ffc",
    "username": "user5",
    "nickname": null,
    "phone": null,
    "gender": 0,
    "email": "user5@example.com",
    "birthday": null,
    "fromDistrict": "北區",
    "signature": "我要考中大",
    "userType": 2,
    "applyDate": "2024-06-05",
    "fromCentre": "香港心理衞生會",
    "toDistrict": "北區",
    "quitCentreDate": "2024-06-05"
  }
}

User apply page​

申請信息分頁顯示

Request (ApplyFilterDTO)​

POST /web/approval/page
{
  "pagination": {
    "page": 1,
    "size": 10
  },
  "sortings": [],
  "loginID": "user",
  "event": 1,
  "centreEnum": "NLPRA"
}

Response (UserApprovalListResp)​

{
  "success": true,
  "message": "",
  "data": {
    "pagination": {
      "page": 1,
      "size": 10,
      "totalItems": 2,
      "totalPages": 1
    },
    "sortings": [],
    "items": [
      {
        "transferId": "18512c64-37c8-4d09-9cde-5aaf29465ffc",
        "userId": "8887d36e-4cbe-4726-94ee-73defa9ac7e3",
        "status": 2,
        "district": "深水埗",
        "applyAt": "2024-06-05T15:31:38.195784",
        "username": "user5",
        "phone": null,
        "email": "user5@example.com",
        "serviceNumber": "12345555"
      },
      {
        "transferId": "c8564608-7716-464e-b199-6b82c0f75140",
        "userId": "8887d36e-4cbe-4726-94ee-73defa9ac7e3",
        "status": 2,
        "district": "深水埗",
        "applyAt": "2024-06-05T12:01:46.763696",
        "username": "user5",
        "phone": null,
        "email": "user5@example.com",
        "serviceNumber": "12345555"
      }
    ]
  }
}

Out centre​

Request (ApplyDTO)​

PUT /web/approval/out-centre
{
  "transferId": "f7de23d3-13ab-4395-9467-f1e8aaead636",
  "isApproved": true
}

Response​

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

Join centre​

Request (ApplyDTO)​

PUT /web/approval/join-centre
{
  "transferId": "f7de23d3-13ab-4395-9467-f1e8aaead636",
  "isApproved": true
}

Response​

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

Out member​

Request (ApplyDTO)​

PUT /web/approval/out-member
{
  "transferId": "f7de23d3-13ab-4395-9467-f1e8aaead636",
  "isApproved": true
}

Response​

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

Join member​

Request (ApplyJoinMemberDTO)​

PUT /web/approval/join-member
{
  "transferId": "f7de23d3-13ab-4395-9467-f1e8aaead636",
  "isApproved": true,
  "serviceNumber": "lalala",
  "level": 2,
  "staffId": "74b334df-8744-45d1-a3ff-12dc29c4e89f"
}

Response​

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

Page count​

Request (ApplyPageCountReq)​

PUT /web/approval/page-count
{
  "loginID": "user"
}

Response (ApplyPageCountResp)​

{
  "success": true,
  "message": "",
  "data": {
    "joinMemberCount": 0,
    "outMemberCount": 0,
    "joinCentreCount": 2,
    "outCentreCount": 0
  }
}

Resources​

UserApprovalInfoDTO​

properties
  • transferId
    string
    required
    申請單號
  • username
    string
    required
    帳號名
  • nickname
    string
    暱稱
  • phone
    string
    手機號碼
  • gender
    int
    required
    性別: 0:男, 1:女
  • email
    string
    電子郵件
  • birthday
    string
    生日
  • fromDistrict
    string
    required
    所屬地區
  • signature
    string
    個性化字眼
  • userType
    int
    required
    用戶類型: 1:普通會員, 2:計畫會員, 3:社區員工
  • applyDate
    Date
    required
    申請日期
  • serviceNumber
    String
    服務編號，僅限申請或註銷計畫會員時出現此字段
  • fromCentre
    String
    所屬機構，僅限入會和退會申請時出現此字段
  • toDistrict
    String
    申請加入地區，僅限入會和退會申請時出現此字段
  • quitCentreDate
    Date
    退會日期，僅限完成退會申請時出現此字段

ApplyFilterDTO​

properties
  • pagination
    Pagination
    required
    分頁信息
  • loginID
    String
    搜索字段。對用戶名、郵箱地址、手機號碼進行模糊搜尋。
  • event
    Int
    required
    申請事件：1:申請計劃會員 2:退出計劃會員 3:入會申請 4:退會申請
  • centreEnum
    centreEnum
    required
    中心代號。當前用戶的中心代號。

UserApprovalListResp​

This class extends PaginationAndSorting

properties
  • transferId
    string
    required
    申請單號
  • userId
    string
    required
    用戶ID
  • status
    int
    required
    申請狀態: 1:申請中, 2:通過, 3:拒絕
  • district
    string
    required
    所屬地區
  • applyAt
    Date
    required
    申請日期
  • username
    string
    帳號名
  • phone
    string
    手機號碼
  • email
    string
    電子郵件
  • serviceNumber
    string
    服務編號

ApplyJoinMemberDTO​

properties
  • transferId
    String
    required
    申請單ID
  • isApproved
    boolean
    required
    是否審核通過，true:通過, false:未通過
  • serviceNumber
    String
    服務編號，僅限申請或註銷計畫會員時出現此字段
  • level
    int
    1，2
    級別
  • staffId
    string
    服務職員ID

ApplyDTO​

properties
  • transferId
    String
    required
    申請單ID
  • isApproved
    boolean
    required
    是否審核通過，true:通過, false:未通過

ApplyPageCountReq​

properties
  • loginID
    String
    搜索字段。對用戶名、郵箱地址、手機號碼進行模糊搜尋。

ApplyPageCountResp​

properties
  • joinMemberCount
    int
    required
    会员申请数量
  • outMemberCount
    int
    required
    会员注销申请数量
  • joinCentreCount
    int
    required
    入会申请数量
  • outCentreCount
    int
    required
    退会申请数量