[update] #todo 129741，將API規格開給前端

wayne

2021-11-08 7e98cb2d77de33db9e5190d8066bc788901f43c3

[update] #todo 129741，將API規格開給前端

此為初版，之後還有很多細修的可能

 pamapi/src/doc/sql/20211108_w.sql

¤ñ¹ï·sÀÉ®×
@@ -0,0 +1,12 @@
CREATE TABLE public.custom_favorite_consultant (
   id serial4 NOT NULL,
   consultant_id int8 NOT NULL,
   custom_id int8 NOT NULL,
   created_date timestamp NULL,
   created_by varchar NULL,
   last_modified_date timestamp NULL,
   last_modified_by varchar NULL,
   contact_status varchar NULL,
   CONSTRAINT custom_consultant_list_pk PRIMARY KEY (id),
   CONSTRAINT custom_consultant_list_fk FOREIGN KEY (consultant_id) REFERENCES public.consultant(id)
);

 pamapi/src/doc/µn¤JAPI/«È¤áµn¤JAPI (For OTP«e´ú¸Õ¥Î).txt

¤ñ¹ï·sÀÉ®×
@@ -0,0 +1,16 @@
æ­¤API目前僅用於 OTP認證開發前 æš«æ™‚使用，若OTP開發完畢後該規格還會再改或棄用
http post: http://localhost:8080/api/authenticate

request body:
{
    "username": "user",
    "password": "user"
}

response body:
{
    "id_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ1c2VyIiwiYXV0aCI6IlJPTEVfVVNFUiIsImV4cCI6MTYzNjQyNTk5Mn0.RinPRcsVABRg0OzJ9scRPmkl89o7N9Rx6os838GIeWbm6AmZmhsMzJ2nO8Uqa1iXX-bXRm5O0XvyFXeEzOEfqA"
}

目前可測試帳號有：user、test
帳密皆一樣

 pamapi/src/doc/ÅU°ÝAPI/«È¤áªºÅU°Ý²M³æ.txt

¤ñ¹ï·sÀÉ®×
@@ -0,0 +1,19 @@
http get: http://localhost:8080/api/consultant/favorite

response body:
[
    {
        "agentNo": "12345",
        "name": "測試推薦業務員",
        "img": "",
        "expertise": [
            "財務規劃",
            "資產轉移"
        ],
        "avgScore": 4.7,
        "contactStatus": "picked",
        "updateTime": "2021-11-02T06:46:13.723Z",
        "seniority": "4å¹´2個月",
        "new": false
    }
]

 pamapi/src/doc/ÅU°ÝAPI/±NÅU°Ý¥[¤J«È¤áªº²M³æ.txt

¤ñ¹ï·sÀÉ®×
@@ -0,0 +1,8 @@
http post: http://localhost:8080/api/consultant/favorite

request body:
{
    "agentNoList": ["12345"]
}

response body: ç„¡ï¼Œå›žhttp status 202

 pamapi/src/doc/ÅU°ÝAPI/§Ö³t¿z¿ï.txt

¤ñ¹ï·sÀÉ®×
@@ -0,0 +1,42 @@
http get: http://localhost:8080/api/consultant/fastQuery

request body:
{
    "gender": "female",
    "communicationStyle": "",
    "avgScore": 4,
    "status": "online"
}

response body:
[
    {
        "agentNo": "12345",
        "name": "測試推薦業務員",
        "img": "",
        "expertise": [
            "財務規劃",
            "資產轉移"
        ],
        "avgScore": 4.7,
        "contactStatus": null,
        "updateTime": null,
        "seniority": "4å¹´2個月",
        "new": false
    },
    {
        "agentNo": "12346",
        "name": "測試業務員",
        "img": "",
        "expertise": [
            "資產轉移",
            "節稅",
            "樂活退休"
        ],
        "avgScore": 3.8,
        "contactStatus": null,
        "updateTime": null,
        "seniority": "2å¹´3個月",
        "new": false
    }
]

 pamapi/src/doc/ÅU°ÝAPI/±ÀÂ˪ºÅU°Ý²M³æ.txt

¤ñ¹ï·sÀÉ®×
@@ -0,0 +1,19 @@
http get: http://localhost:8080/api/consultant/recommend

response body:
[
    {
        "agentNo": "12345",
        "name": "測試推薦業務員",
        "img": "",
        "expertise": [
            "財務規劃",
            "資產轉移"
        ],
        "avgScore": 4.7,
        "contactStatus": null,
        "updateTime": null,
        "seniority": "4å¹´2個月",
        "new": false
    }
]

 pamapi/src/doc/ÅU°ÝAPI/ÅU°Ý²Ó¸`.txt

¤ñ¹ï·sÀÉ®×
@@ -0,0 +1,28 @@
http get: http://localhost:8080/api/consultant/detail?agentNo={agentNo}

response body:
{
    "name": "測試推薦業務員",
    "agentNo": "12345",
    "role": "保險經紀人",
    "image": "",
    "avgScore": 4.7,
    "title": "專案經理",
    "phoneNumber": "0912345678",
    "serveArea": "台北市地區",
    "companyAddress": "台北市信義區忠孝東路一段1號",
    "latestLoginTime": null,
    "seniority": "4å¹´2個月",
    "suitability": 0,
    "evaluation": 0,
    "expertises": [
        "財務規劃",
        "資產轉移"
    ],
    "concept": "壽險路上沒有捷徑，唯有給客戶信任感、安全感，才是最好的方法。從業以來，我一直秉持著「助人為快樂之本」的信念堅持著，她相信，一個好的業務人員，必須抱持著一顆熱心助人的心，才是永續經營壽險事業的不二法門。",
    "experiences": [
        "台大財金系",
        "美莓有精算師執政"
    ],
    "awards": "入選：2020年伯樂十大最佳業務員 æ“æœ‰è­‰ç…§ï¼šäººèº«ä¿éšªæ¥­å‹™å“¡è­‰ç…§ã€å¤–幣收付保險證照、人身保險代理人證照、財產保險代理人證照"
}