エラー仕様
API使用中にエラーが発生すると、ECHOからエラーオブジェクトが返却されます。
エラーオブジェクト
エラーオブジェクトは、エラーコードとそれに対応するエラーメッセージによって構成されています。
また、バリデーションエラーなどの一部エラーでは、エラーの詳細を表現するフィールドが付加されます。
{error_code:"エラーコード", error_message:"エラーメッセージ", error_details:{エラー詳細}}
エラーコード一覧
| エラーコード (error_code) | HTTP ステータス コード | エラーメッセージ (error_message) | 内容 | 詳細フィールド (error_details) |
|---|---|---|---|---|
| 110010 | 404 | Resource not found | インスタンスが存在しない または、リソースが存在しない |
- |
| 110020 | 404 | Not found or Forbidden | コンテンツが見つからない または、ACLでアクセス権限が与えられていないコンテンツにアクセスした |
- |
| 110030 | 405 | Method not allowed | 要求したメソッドを許可していない | - |
| 110040 | 415 | Unsupported media type | リクエストヘッダーのContent-Typeが、「application/json」または「 multipart/form-data」以外 | - |
| 110050 | 400 | Invalid JSON format | JSONフォーマットが不正 | - |
| 100010 | 403 | Application ID (X-ECHO-APP-ID) not specified | アプリケーションIDが指定されていない | - |
| 100020 | 403 | Application key (X-ECHO-APP-KEY) not specified | アプリケーションキーが指定されていない | - |
| 100030 | 403 | Invalid API application | アプリケーションが見つからない | - |
| 130000 | 403 | Operation not permitted with your ACL | 要求した操作権限が与えられていない | - |
| 130010 | 401 | Authentication error with ID/PASS incorrect | ログインエラー | - |
| 130020 | 401 | Access token (X-ECHO-ACCESS-TOKEN) incorrected or expired | アクセストークンが無効 | - |
| 150000 | 400 | Validation errors occurred | バリデーションエラーが発生 | エラーが発生したフィールドとエラー内容 |
| 150010 | - | Not setted | 必須フィールドが未入力 | - |
| 150020 | - | Contained restricted character | 使用できない文字が含まれている | - |
| 150030 | - | Too long | 入力された文字が長すぎる | - |
| 150040 | - | Non unique | データが他と重複している | - |
| 150050 | - | Contained non-numeric character | 数値以外が入力されている | - |
| 150060 | - | Invalid email format | メールアドレスが不正 | - |
| 150070 | - | Reference looped | 参照ループが発生している | - |
| 150080 | - | Invalid phone number format | 電話番号が不正 | - |
| 150090 | - | Invalid date string format | 日時形式が不正 | - |
| 150100 | - | Invalid zip code format | 郵便番号が不正 | - |
| 150110 | - | Reference not exist | 参照データが存在しない |