# API007
頁 次 : 1 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
企業跳蚤市場
企業跳蚤市場許願池增修刪儲存
需求規格書
| 哈哈 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Text | Text | Text |
文件編號: GoG-EnterpriseAPP-API-007
版 次: V1.2
製作日期: 2022.12.28
頁 次 : 2 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
修 訂 履 歷
版次 發行日期 作者 修 訂 內 容 備 註
V1.0 2022.05.21 林紋慈 初版發行
V1.1 2022.05.30 林紋慈 許願池新增按讚功能
V1.2 2022.07.29 劉鎧禎 新增許願池取消按讚功能
V1.3 2022.12.28 劉鎧禎 調整版本號規則 因應企業版APP
頁 次 : 3 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
目 錄
1. 需求描述 5
1-1. 需求說明 5
1-2. 作業流程圖 5
2. 作業執行步驟 5
2-1. 作業執行步驟彙整 5
2-2. API 執行步驟項目詳細說明 6
2-3. 例外處理 7
2-4. API 規格及範例 8
頁 次 : 4 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
圖表目錄
圖-1. API-007 企業跳蚤市場許願池流程圖 5
圖-2. API-007 作業流程彙整 6
頁 次 : 5 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
1. 需求描述
1-1. 需求說明
GoG 企業會員進入跳蚤市場->許願池功能後,可點選自己許願的資料進行修改/刪除, 或點選新增按鈕新增許願內容,完成動作選按確認按鈕後透過此API 將該筆許願內容進行增刪修儲存至資料庫。
1-2. 作業流程圖
圖-1. API-007 企業跳蚤市場許願池流程圖
2. 作業執行步驟
2-1. 作業執行步驟彙整
頁 次 : 6 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
圖-2. API-007 作業流程彙整
2-2. API 執行步驟項目詳細說明
2-2-1. 企業跳蚤市場許願池資料增刪修儲存作業啟動
2-2-1-1. 記錄SystemLog
[YYYYMMDDHHMMSS] EnterpriseAPP-API-007 步驟:企業跳蚤市場許願池資料增刪修儲存作業啟動
2-2-1-2. API 作業啟動:
1. 傳入【#增刪修異動代碼】和許願欄位資料。
2-2-2. 許願池資料增刪修儲存作業
2-2-2-1. 記錄SystemLog:
[YYYYMMDDHHMMSS] EnterpriseAPP-API-007 步驟:進行許願池資料增刪修儲存作業,異動代碼:【#異動代碼】、資料序號:【#資料序號】
2-2-2-2. 資料增刪修儲存至資料庫: 新增:
以傳入資料欄位至【企業跳蚤市場許願池(corp_fm_wish)】將資料新增進去。
頁 次 : 7 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
修改/刪除:
以傳入之【#資料序號】至【企業跳蚤市場許願池(corp_fm_wish)】進行資料刪除修改。
按讚:
以傳入之【#資料序號】至【企業跳蚤市場許願池(corp_fm_wish)】將 wish_like_cnt
進行加 1 後更新該欄位。
同時將該筆員工按讚資料(like_emp_id、like_emp_phone)新增一筆紀錄至許願池按讚明細檔<corp_fm_wish_like>。
*自己無法對自己許願物品按讚取消按讚:
以傳入之【#資料序號】至【企業跳蚤市場許願池(corp_fm_wish)】將 wish_like_cnt
進行減 1 後更新該欄位。
同時將該筆員工按讚資料(like_emp_id、like_emp_phone)自明細檔
<corp_fm_wish_like>移除。成功後記錄SystemLog
2-2-2-3. 成功後紀錄SystemLog:
紀錄SystemLog:
[YYYYMMDDHHMMSS] EnterpriseAPP-API-007 步驟:進行許願池資料增刪修儲存作業,異動代碼:【#異動代碼】、資料序號:【#資料序號】,作業成功。
2-2-3. 結束
2-2-3-1. 記錄SystemLog:
[YYYYMMDDHHMMSS] EnterpriseAPP-API-007 步驟:許願池資料增刪修儲存作業結束
2-2-3-2. 結束流程。
2-3. 例外處理
2-3-1-1. 若執行中有發生異常,將攔截到的exception 訊息記錄ErrorLog: [YYYYMMDDHHMMSS] EnterpriseAPP-API-007 發生異常:【#攔截到的
exception 訊息】
頁 次 : 8 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
2-4. API 規格及範例
API No EnterpriseAPP-API-007
API Name setCorpFMWish
URL ${url}/APP/getData/setCorpFMWish
Purpose 許願池資料增刪修儲存作業
Description 透過API 進行許願池資料增刪修儲存作業
Protocol JSON over HTTP POST
Content-Type Content-Type=application/json
底層介接
Request JSON Object
參數 型態 必填 長度 說明
modify_type String Y 1 C:新增 U:修改 D:刪除 P:
按讚 N:取消按讚
seq_id Int 新增時為空白
修改刪除時為必填
wish_item_nm String 刪除時可空白
新增修改時為必填
corp_id String Y 從APP 儲存的取出
emp_id String Y 從APP 儲存的取出
emp_phone String Y 從APP 儲存的取出
emp_ext String Y 從APP 儲存的取出
wish_lease_type String 刪除時可空白
新增修改時為必填
按讚時可空白
wish_unit_amt
Int 刪除、按讚時可空白新增修改時且
wish_lease_type=’1’為必填
wish_period_unit
String 刪除、按讚時可空白新增修改時為且
wish_lease_type=’1’為必填
wish_sale_amt
Int 刪除、按讚時可空白新增修改時且
wish_lease_type=’2’為必填
wish_title String Y 刪除、按讚時可空白
新增修改時為必填
wish_content String Y 刪除、按讚時可空白
新增修改時為必填
Response JSON Object
參數 型態 必回 說明
result String Y API 執行結果,Y:成功, N:
頁 次 : 9 / 9
文件編號:
GOG-EnterpriseAPP-API-007 文件名稱:企業跳蚤市場許願池增修刪儲存 機密等級:一般
失敗
message String N API 執行失敗的訊息說明
Request Sample (Json)
資料格式 說明
var input = { "modify_type":"C",
"seq_id":"", "corp_id":"gogreen", "emp_id":"00002", "emp_phone":"0988xxxxxx", "wish_lease_type":"1,2", "wish_unit_amt":"10", "wish_period_unit":"D", "wish_sale_amt":"100", "wish_title":"許願【睡袋】",
"wish_content":"請問有人有【睡袋】可【出租/轉售】嗎? 希望租金為
【10元/天】,希望售金為【100】,請與分機xxxx聯絡,或刊登至跳 蚤市場。謝謝!"
}
Json Request Sample
Response Sample
資料格式 說明
{
"result": "Y", API 結果
Result=Y 時才會有資料
"message": "" API 訊息
Ex: "執行失敗, 原因:
XXXXXXXXX"
}