エラー定義

Messaging API で何らかのエラーが発生した場合、HTTP ステータスコードで 2xx 以外の値を応答するとともに、以下のようなエラー情報を持った JSON を返します。

‍

Global Errors

何らかの理由によりリクエストが受け付けられなかった際に発生します。 エラー内容は code の値によって識別できます。

‍

JSON 構造

Global Error の場合、 path には常に __global__ が指定されます。

{
  "errors": [
    {
      "path": "__global__",
      "code": "{Error Code}"
    }
  ]
}

‍

エラーコード一覧

‍

Client Side Errors

‍

Server Side Errors

‍

Validation Errors

リクエスト内容のデータベースへの保存が失敗した際に発生します。
主に操作者がフォームに入力した内容に不備がある場合に使用され、内容の修正を促すレスポンスが返されます。

応答される HTTP Status Code は 422 Unprocessable Content です。

‍

JSON 構造

path にはエラーのある form field を示すパスが含まれます。

option は後述のエラーコードの Description に含まれる %{count} などの変数値を表します。Description に変数が含まれない場合は省略されます。

{
  "errors": [
    {
      "path": "{Path}",
      "code": "{Error Code}",
      "option": {
        "{variable_name}": "{variable_value}"
      }
    },
    {
      "path": "{Path}",
      "code": "{Error Code}"
    }
  ]
}

‍

エラーコード一覧

path に * が指定されているものは path の値に関係なく発生する可能性があります。

path に固有の値が指定されているものは、その path 固有のエラーです。

‍

‍

‍