# eGroupAI 常用 Http status code 內容 ＆ 說明
###### tags: `eGroupAI 開發規範`

這份文件整理出目前服務所有 API Http response status code 以及其對照之說明

## 2xx - 成功 (OK)這類的狀態碼表示伺服器成功接收到用戶端要求、

理解用戶端要求、以及接受用戶端要求。
* 200 - 確定。 用戶端要求成功。
用於請求成功且有回傳值，若是 get list 時結果為空則是回傳空的 list
* 204 - 無內容。
用於沒有回傳值的請求成功

## 4xx - 用戶端錯誤 (Client Error)這代表錯誤發生，且這錯誤的發生的原因跟「用戶端」有關。

例如：用戶端可能連結到不存在的頁面、用戶端的權限不足、或可能未提供有效的驗證資訊(輸入的帳號、密碼錯誤)。

* 400 - 錯誤的要求。
通常由模組自動回傳
* 401 - 拒絕存取。有下列表現形式
* 401.1 - Incorrect account or password
* 401.2 - Token is expired
* 401.3 - Token is invalid
* 403 - 禁止使用。有下列表現形式
* 403.1 - No access permission
* 403.2 - No read permission.
* 403.3 - No write permission.
* 403.4 - No delete permission.
* 409 - 重複新增，例如
帳號已存在
身分證 已存在
電話已存在 etc.
* 422 - 資料殘缺、不符合完整格式，例如
缺少必填欄位
資料格式不正確
null 、 undefined 的資料
* 400 - 請求被認定有誤，Server 不能或不會處理該請求，例如 request method、header 錯誤
* 401 - 用戶登入相關的錯誤資訊
* 403 - 用戶登入後有沒有使用的權限
access permission 用戶可不可以訪問該筆資料，例如派案、派課etc
read 、 write 、 delete 則是用戶可不可以進行這些操作，一般來說是由其他使用者（管理者）決定
* 404 - 找無資源、頁面、路徑
若是 get 單筆資料找無時應該回傳 404 並且在 message 表示找無該筆資料

## eGroupAI 自定義的 Http status code

* 450 ~ 463 - 人臉辨識相關的錯誤 (FaceRecognition EngineError)
* 450 - LICENSE_VERIFY_FAIL
* 451 - ENGEIN_STARTUP_ATTRIBUTE_ERROR
* 452 - ENGEIN_FILE_LOST
* 453 - HARDWARE_CHECK_FAIL
* 454 - STORAGE_CHECK_FAIL
* 455 - VIDEO_CHECK_FAIL
* 456 - CNN_MODEL_LOST
* 457 - USERS_MODEL_DESTORY
* 458 - LOAD_USERS_MODEL_FAIL
* 459 - OUTPUT_FOLDER_NOT_EXIST
* 460 - TRAIN_FAIL_MODEL_CREATE
* 461 - TRAIN_FAIL_LOG
* 462 - TRAIN_FAIL_FACE
* 463 - MODEL_SWITCH_FAIL

* 464 ~ 476 - api 伺服器錯誤 (API Server Error)
* 464 - SERVICE_GROUP_NOT_EXIST
* 465 - SERVER_ENGINE_LOAD_MODEL
* 466 - FRAME_NO_FACE
* 467 - FRAME_NO_SIMILARFACE
* 468 - OUTPUT_JSON_NOT_EXIST
* 469 - SERVER_ENGINE_TIMEOUT
* 472 - TRAIN_QUALITY_BLURNESS
* 473 - TRAIN_QUALITY_HEADPOSE
* 474 - TRAIN_QUALITY_LOWLUMINANCE
* 475 - TRAIN_QUALITY_HIGHLUMINANCE
* 476 - SEND_EMAIL_FAIL

* 47x - api 應用程式錯誤 (Application Error)
* 470 - FILE_NOT_EXIST
* 471 - MD5_ENCRYPT_FAIL
* 48x - AWS 錯誤 (Aws Error)
* 480 - S3_UPLOAD_FAIL
* 481 - S3_FILE_NOT_EXIST

## 5xx - 伺服器錯誤 (Server Error)這代表錯誤發生，且這錯誤發生的原因跟「伺服器」有關。

伺服器因為發生錯誤或例外狀況(Exception)而無法完成要求(Request)時，就會回應 5xx 的錯誤，且這肯定跟伺服器有關。

* 500 - 伺服器錯誤
有 BUG 或是伺服器等問題