Documentation Powered by ReDoc

廟務系統 (1.0)

Download OpenAPI specification:Download

Authentication

AdminAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

User

使用者 API

登出

登出

Responses

新增後台用戶

Request Body schema: application/json
username
required
string

帳號

password
required
string^[a-zA-Z\d!@#$%^&*()_+|~\-={}[\]:;<>?,./]{6,}...

密碼 (最少 6 碼，允許英文數字與符號但不包含空白)

nickname
string

暱稱

remark
string

備註

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "nickname": "string",
  • "remark": "string"
}

後台用戶列表

query Parameters
pageIndex
required
number

目前分頁位置

countPerPage
required
number

每頁資料數量

Responses

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPageIndex": 0,
  • "totalCount": 0,
  • "records": [
    ]
}

取得後台用戶明細

path Parameters
userId
required
number

後台用戶 id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "nickname": "string",
  • "remark": "string"
}

更新後台用戶

path Parameters
userId
required
number

後台用戶 id

Request Body schema: application/json
password
string^[a-zA-Z\d!@#$%^&*()_+|~\-={}[\]:;<>?,./]{6,}...

密碼 (最少 6 碼，允許英文數字與符號但不包含空白)

nickname
string

暱稱

remark
string

備註

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "nickname": "string",
  • "remark": "string"
}

後台登入

Request Body schema: application/json
username
required
string

帳號

password
required
string^[a-zA-Z\d!@#$%^&*()_+|~\-={}[\]:;<>?,./]{6,}...

密碼 (最少 6 碼，允許英文數字與符號但不包含空白)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

驗證 User

Authorizations:
AdminAuth

Responses

Members

會員 API

編輯會員

編輯會員

Authorizations:
AdminAuth
path Parameters
memberId
required
number

會員 id

Request Body schema: application/json
name
string

姓名

mobile
string

手機電話

address
string

地址

gender
string
Enum: "male" "female"

性別

panguFamily
boolean

盤古家族成員

birthday
string <date-time>

生日

birthdayType
string
Enum: "solar" "lunar"

出生年月日種類:

  • solar: 國曆
  • lunar: 農曆
mainContact
boolean

主要聯絡人

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "mobile": "string",
  • "address": "string",
  • "gender": "male",
  • "panguFamily": true,
  • "birthday": "2019-08-24T14:15:22Z",
  • "birthdayType": "solar",
  • "mainContact": true
}

取得會員明細資料

取得會員明細資料

Authorizations:
AdminAuth
path Parameters
memberId
required
number

會員 id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "memberNo": "string",
  • "name": "string",
  • "mobile": "string",
  • "address": "string",
  • "gender": "male",
  • "panguFamily": true,
  • "solarBirthday": "2019-08-24T14:15:22Z",
  • "lunarBirthday": "2019-08-24T14:15:22Z",
  • "zodiac": "string",
  • "mainContact": true,
  • "enable": true,
  • "familyMembers": [
    ]
}

匯入會員資料

匯入會員資料

Authorizations:
AdminAuth
Request Body schema: multipart/form-data
socketClientId
string

socket id

file
string <binary>

Responses

啟用帳號

啟用帳號

Authorizations:
AdminAuth
Request Body schema: application/json
ids
Array of integers[ items ]

帳號 id

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

停用帳號

停用帳號

Authorizations:
AdminAuth
Request Body schema: application/json
ids
Array of integers[ items ]

帳號 id

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

取得會員列表

取得會員列表

Authorizations:
AdminAuth
query Parameters
sorter
string
Example: sorter=name.asc

排序, 格式: {columnName}.{asc | desc}

pageIndex
required
number

目前分頁位置

countPerPage
required
number

每頁資料數量

mobile
string

手機電話號碼(可模糊查詢)

name
string

姓名(可模糊查詢)

panguFamily
boolean

是否盤古家族成員

gender
string
Enum: "male" "female"

性別

address
string

地址 (可模糊查詢)

enable
boolean

帳號啟用狀態

includeMemberIds
Array of integers[ items ]

包含在搜尋結果內的會員 id

strictSearch
string
Example: strictSearch=address

嚴格搜尋，格式: {columnName} support: address

Responses

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPageIndex": 0,
  • "totalCount": 0,
  • "records": [
    ]
}

新增會員

新增會員

Authorizations:
AdminAuth
Request Body schema: application/json
name
required
string

姓名

mobile
required
string

手機電話

address
required
string

地址

gender
required
string
Enum: "male" "female"

性別

panguFamily
required
boolean

盤古家族成員

birthday
required
string <date-time>

生日

birthdayType
required
string
Enum: "solar" "lunar"

出生年月日種類:

  • solar: 國曆
  • lunar: 農曆
mainContact
boolean

主要聯絡人

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "mobile": "string",
  • "address": "string",
  • "gender": "male",
  • "panguFamily": true,
  • "birthday": "2019-08-24T14:15:22Z",
  • "birthdayType": "solar",
  • "mainContact": true
}

Response samples

Content type
application/json
Example
錯誤的日期格式
錯誤的日期格式
手機重複
{
  • "code": 400001,
  • "message": "錯誤的日期格式"
}

Activities

活動 API

修改活動類別

修改活動類別

Authorizations:
AdminAuth
path Parameters
categoryId
required
number

類別 id

Request Body schema: application/json
name
string

活動名稱

signUpUnitType
string

報名單位類型

autoGenerateSerialNumber
boolean

自動產生單位序號

oneUnitPerPerson
boolean

自動設定一人一單位

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "signUpUnitType": "string",
  • "autoGenerateSerialNumber": true,
  • "oneUnitPerPerson": true
}

取得活動類別明細

取得活動類別明細

Authorizations:
AdminAuth
path Parameters
categoryId
required
number

類別 id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "signUpUnitType": "string",
  • "autoGenerateSerialNumber": true,
  • "oneUnitPerPerson": true
}

編輯活動報名會員(by 戶別)

編輯活動報名會員(by 戶別)

Authorizations:
AdminAuth
path Parameters
signUpMemberId
required
number

主要報名會員 id

Request Body schema: application/json
amount
number

金額

totalUnit
number

報名總單位

organizationId
number

活動金額樂捐對象組織

object (ActivityRemarkModify)

活動備註

Array of objects[ items ]

一同報名家屬 id

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "totalUnit": 0,
  • "organizationId": 0,
  • "remarks": {
    },
  • "familyMembers": [
    ]
}

取得活動報名會員明細資料

取得活動報名會員明細資料

Authorizations:
AdminAuth
path Parameters
signUpMemberId
required
number

報名會員 id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "member": {
    },
  • "activity": {
    },
  • "totalUnit": 0,
  • "amount": 0,
  • "sequence": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "organization": {
    },
  • "signUpFamilies": [
    ],
  • "remarks": [
    ]
}

取得活動備註

取得活動備註

Authorizations:
AdminAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

刪除活動類別

刪除活動類別

Authorizations:
AdminAuth
query Parameters
ids
Array of numbers[ items ]

欲刪除的 id

Responses

取得活動類別列表

取得活動類別列表

Authorizations:
AdminAuth
query Parameters
sorter
string
Example: sorter=name.asc

排序, 格式: {columnName}.{asc | desc}

pageIndex
required
number

目前分頁位置

countPerPage
required
number

每頁資料數量

Responses

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPageIndex": 0,
  • "totalCount": 0,
  • "records": [
    ]
}

新增活動類別

新增活動類別

Authorizations:
AdminAuth
Request Body schema: application/json
name
required
string

活動名稱

signUpUnitType
required
string

報名單位類型

autoGenerateSerialNumber
boolean

自動產生單位序號

oneUnitPerPerson
boolean

自動設定一人一單位

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "signUpUnitType": "string",
  • "autoGenerateSerialNumber": true,
  • "oneUnitPerPerson": true
}

編輯活動

編輯活動

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

Request Body schema: application/json
name
string

活動名稱

categoryId
number

活動類別 id

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "categoryId": 0
}

取得活動明細

取得活動明細

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "activityCategory": {
    }
}

匯入活動報名成員

匯入活動報名成員

path Parameters
activityId
required
string

活動 id

Request Body schema: multipart/form-data
amount
number

報名金額/人

socketClientId
string

回傳上傳進度的 socket id

file
required
string <binary>

Responses

新增活動報名會員(by 戶別)

新增活動報名會員(by 戶別)

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

Request Body schema: application/json
memberId
required
integer

會員 id

totalUnit
required
integer

報名總單位

amount
required
number

金額

organizationId
required
number

活動金額樂捐對象組織

object (ActivityRemarkModify)

活動備註

Array of objects[ items ]

一同報名家屬 id

Responses

Request samples

Content type
application/json
{
  • "memberId": 0,
  • "totalUnit": 0,
  • "amount": 0,
  • "organizationId": 0,
  • "remarks": {
    },
  • "familyMembers": [
    ]
}

刪除活動報名會員

刪除活動報名會員

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

query Parameters
ids
required
Array of numbers[ items ]

欲刪除的報名 id

Responses

新增活動報名會員

新增活動報名會員

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

Request Body schema: application/json
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "signUpMembers": [
    ]
}

取得活動報名會員列表

取得活動報名會員列表

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

query Parameters
sorter
string
Example: sorter=name.asc

排序, 格式: {columnName}.{asc | desc}

pageIndex
required
number

目前分頁位置

countPerPage
required
number

每頁資料數量

name
string

會員姓名

remarkIds
Array of integers[ items ]

備註項目

memberIds
Array of integers[ items ]

信眾會員 id

Responses

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPageIndex": 0,
  • "totalCount": 0,
  • "records": [
    ]
}

取得可報名活動的會員列表

取得可報名活動的會員列表

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

query Parameters
sorter
string
Example: sorter=name.asc

排序, 格式: {columnName}.{asc | desc}

pageIndex
required
number

目前分頁位置

countPerPage
required
number

每頁資料數量

name
string

會員名稱 (可模糊搜尋)

includeMemberIds
Array of numbers[ items ]

包含在搜尋結果內的會員

Responses

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPageIndex": 0,
  • "totalCount": 0,
  • "records": [
    ]
}

取得活動明細統計總表

取得活動明細統計總表

Authorizations:
AdminAuth
path Parameters
activityId
required
string

活動 id

Responses

Response samples

Content type
application/json
{
  • "totalSignUpUnit": 0,
  • "signUpUnitType": "string",
  • "totalAmount": 0
}

刪除活動

刪除活動

Authorizations:
AdminAuth
query Parameters
ids
Array of numbers[ items ]

欲刪除的活動 id

Request Body schema: application/json
ids
required
Array of numbers[ items ]

欲刪除的 id 清單

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

新增活動

新增活動

Authorizations:
AdminAuth
Request Body schema: application/json
name
required
string

活動名稱

categoryId
required
number

活動類別 id

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "categoryId": 0
}

取得活動列表

取得活動列表

Authorizations:
AdminAuth
query Parameters
sorter
string
Example: sorter=name.asc

排序, 格式: {columnName}.{asc | desc}

pageIndex
required
number

目前分頁位置

countPerPage
required
number

每頁資料數量

name
string

活動名稱 (可模糊查詢)

categoryId
number

活動類別

Responses

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPageIndex": 0,
  • "totalCount": 0,
  • "records": [
    ]
}

Accounting

帳務 API

編輯樂捐帳務

編輯樂捐帳務

Authorizations:
AdminAuth
path Parameters
donationId
required
number

帳務 id

Request Body schema: application/json
memberId
number

捐款人會員 id

amount
number

捐款金額

donationAt
string <date-time>

捐款日期

donationWayId
number

捐款方式 id

Responses

Request samples

Content type
application/json
{
  • "memberId": 0,
  • "amount": 0,
  • "donationAt": "2019-08-24T14:15:22Z",
  • "donationWayId": 0
}

取得捐款方式

取得捐款方式

Authorizations:
AdminAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

新增樂捐帳務

新增樂捐帳務

Authorizations:
AdminAuth
Request Body schema: application/json
memberId
required
number

捐款人會員 id

amount
required
number

捐款金額

donationAt
required
string <date-time>

捐款日期

donationWayId
required
number

捐款方式 id

Responses

Request samples

Content type
application/json
{
  • "memberId": 0,
  • "amount": 0,
  • "donationAt": "2019-08-24T14:15:22Z",
  • "donationWayId": 0
}

刪除樂捐帳務

刪除樂捐帳務

Authorizations:
AdminAuth
query Parameters
ids
required
Array of integers[ items ]

欲刪除的 id

Responses

取得樂捐帳務列表

取得樂捐帳務列表

Authorizations:
AdminAuth
query Parameters
countPerPage
required
number

每頁資料數量

pageIndex
required
number

目前分頁位置

sorter
string
Example: sorter=name.asc

排序, 格式: {columnName}.{asc | desc}

name
string

捐款人名稱（可模糊查詢）

donationWayId
number

捐款方式 id

donationStartAt
string <date-time>

捐款日起（起）

donationEndAt
string <date-time>

捐款日起（迄）

Responses

Response samples

Content type
application/json
{
  • "totalPage": 0,
  • "currentPageIndex": 0,
  • "totalCount": 0,
  • "records": [
    ]
}

取得樂捐帳務列表統計資訊

取得樂捐帳務列表統計資訊

Authorizations:
AdminAuth
query Parameters
name
string

捐款人名稱（可模糊查詢）

donationWayId
number

捐款方式 id

donationStartAt
string <date-time>

捐款日起（起）

donationEndAt
string <date-time>

捐款日起（迄）

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "totalAmount": 0
}

Print

列印 API

取得活動報名信眾的列印資料

取得活動報名信眾的列印資料

Authorizations:
AdminAuth
path Parameters
activityId
required
number

活動 id

Request Body schema: application/json
memberIds
Array of numbers[ items ]

欲列印的收件者 id, 為空則顯示全部

Responses

Request samples

Content type
application/json
{
  • "memberIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

取得主要聯絡人的郵件收件者清單

取得主要聯絡人的郵件收件者清單

Authorizations:
AdminAuth
Request Body schema: application/json
memberIds
Array of numbers[ items ]

欲列印的收件者 id, 為空則顯示全部

Responses

Request samples

Content type
application/json
{
  • "memberIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Utils

額外功能 API

取得郵遞區號資料

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization

組織 API

取得樂捐組織列表

取得樂捐組織列表

Authorizations:
AdminAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]