會員系統 API 文件

會員系統 API 文件說明


1.3 查詢員工帳號 List Staffs

<h3>查詢員工帳號 API</h3> <h5>說明</h5> <ul> <li>提供取得員工資料清單。</li> <li>Request 參數可以不傳,若傳入多個,則代表查詢條件為多個參數的 and 組合。</li> </ul> <hr /> <h5>Request URL</h5> <ul> <li><strong><em><code>GET</code></em></strong> <code>/api/v1/staffs/search</code></li> </ul> <hr /> <h5>Request Parameters</h5> <table> <thead> <tr> <th style="text-align: left;">參數</th> <th style="text-align: left;">必填</th> <th style="text-align: left;">類型</th> <th>說明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td style="text-align: left;">員工ID</td> <td></td> </tr> <tr> <td style="text-align: left;">employee_code</td> <td style="text-align: left;">string</td> <td style="text-align: left;">員工編號</td> <td></td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td style="text-align: left;">姓名</td> <td>陳小明</td> </tr> <tr> <td style="text-align: left;">email</td> <td style="text-align: left;">string</td> <td style="text-align: left;">Email</td> <td>mymail@example.com</td> </tr> <tr> <td style="text-align: left;">service_unit</td> <td style="text-align: left;">string</td> <td style="text-align: left;">部門名稱</td> <td>台北微型企業一科</td> </tr> <tr> <td style="text-align: left;">job_level</td> <td style="text-align: left;">string</td> <td style="text-align: left;">職稱</td> <td>資深專員</td> </tr> <tr> <td style="text-align: left;">mobile_phone</td> <td style="text-align: left;">string</td> <td style="text-align: left;">手機號碼</td> <td>911234567</td> </tr> <tr> <td style="text-align: left;">line_contact_url</td> <td style="text-align: left;">string</td> <td style="text-align: left;">Line 連結</td> <td></td> </tr> <tr> <td style="text-align: left;">avatar_url</td> <td style="text-align: left;">string</td> <td style="text-align: left;">頭像圖片網址</td> <td></td> </tr> <tr> <td style="text-align: left;">enabled_at</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">啟用日</td> <td>2021/11/16 16:49</td> </tr> <tr> <td style="text-align: left;">leave_at</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">離職日</td> <td>2021/11/16 16:49</td> </tr> </tbody> </table> <hr /> <h5>Response Parameters</h5> <table> <thead> <tr> <th style="text-align: left;">參數</th> <th style="text-align: left;">類型</th> <th style="text-align: left;">說明</th> <th style="text-align: left;">範例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td style="text-align: left;">會員ID</td> <td style="text-align: left;">vqx79r52rz50</td> </tr> <tr> <td style="text-align: left;">employee_code</td> <td style="text-align: left;">string</td> <td style="text-align: left;">員工編號</td> <td style="text-align: left;">ABC001</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td style="text-align: left;">姓名</td> <td style="text-align: left;">陳小明</td> </tr> <tr> <td style="text-align: left;">email</td> <td style="text-align: left;">string</td> <td style="text-align: left;">Email</td> <td style="text-align: left;">mymail@example.com</td> </tr> <tr> <td style="text-align: left;">service_unit</td> <td style="text-align: left;">string</td> <td style="text-align: left;">部門名稱</td> <td style="text-align: left;">台北微型企業一科</td> </tr> <tr> <td style="text-align: left;">job_level</td> <td style="text-align: left;">string</td> <td style="text-align: left;">職稱</td> <td style="text-align: left;">資深專員</td> </tr> <tr> <td style="text-align: left;">mobile_phone</td> <td style="text-align: left;">string</td> <td style="text-align: left;">手機號碼</td> <td style="text-align: left;">911234567</td> </tr> <tr> <td style="text-align: left;">line_contact_url</td> <td style="text-align: left;">string</td> <td style="text-align: left;">Line 連結</td> </tr> <tr> <td style="text-align: left;">avatar_url</td> <td style="text-align: left;">string</td> <td style="text-align: left;">頭像圖片網址</td> </tr> <tr> <td style="text-align: left;">enabled_at</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">啟用日</td> <td style="text-align: left;">2021/11/16 16:49</td> </tr> <tr> <td style="text-align: left;">leave_at</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">離職日</td> <td style="text-align: left;">2021/11/16 16:49</td> </tr> </tbody> </table> <hr /> <h5>Request Sample</h5> <pre><code>{ "name":"陳小明" }</code></pre> <hr /> <h5>Response Sample</h5> <pre><code>{ "status": "success", "data": [ { "id":"vqx79r52rz50", "employee_code":"A090110", "name":"陳小明", "email":"mymail@example.com", "service_unit":"台北微型企業一科", "job_level":"資深專員", "mobile_phone":"0911234567", "line_contact_url":"https://www.ccc.cc/", "avatar_url":"https://www.ccc.cc/", "enabled_at":"2021-11-16 16:49:00", "leave_at":"2021-11-16 16:49:00", "current_branch_id":13 "created_at":"2021-11-16 16:49:00", "updated_at":"2021-11-16 16:49:00" }, { "id":"jexd94l26rl3", "employee_code":"A090111", "name":"陳小明", "email":"mymail2@example.com", "service_unit":"台北微型企業2科", "job_level":"資深專員", "mobile_phone":"0922234567", "line_contact_url":"https://www.ccc.cc/", "avatar_url":"https://www.ccc.cc/", "enabled_at":"2021-11-16 16:49:00", "leave_at":"2021-11-16 16:49:00", "current_branch_id":13 "created_at":"2021-11-16 16:49:00", "updated_at":"2021-11-16 16:49:00" } ] } </code></pre>

页面列表

ITEM_HTML