API共通エラー情報

API共通のエラー情報を以下に示します。

ステータス

リクエストのステータスを返却する。

400：
パラメーターに不正がある場合、または、リクエストボディに指定するJSON形式のデータフォーマットに誤りがある場合。
401：
認証エラー。認証トークンが存在しない場合、または認証トークンに誤りがある場合。
404：
存在しないURLが指定された場合、またはURLの指定に誤りがある場合。
500：
サービスの内部エラーの場合。
503：
サービスが一時的に利用できない場合。
504：
一定時間内(1分)に処理が完了しない場合。
Data Type Cardinality
int 1..1

エラー情報は以下のように返却されます。

Response Headers

Content-Length

ヘッダーを除いたリクエスト長(Byte) 。

Data Type Cardinality
String 1..1

Content-Type

コンテントタイプ。

text/plain：
ステータスが401の場合。
application/json：
ステータスが401以外の場合。
Data Type Cardinality
String 1..1

Date

レスポンスの日時。

Data Type Cardinality
String 1..1

WWW-Authenticate

認証サービスのURL。認証エラーの場合のみ出力されます。

Data Type Cardinality
String 0..1

Response Elements

error_message

エラー情報コンテナ。

Data Type Cardinality Parent Element Child Element(s)
Element 1..1 None debuginfo

faultcode

faultstring

debuginfo

デバック情報。

Data Type Cardinality Parent Element Child Element(s)
Stinrg 1..1 error_message None

faultcode

エラーコード。

Data Type Cardinality Parent Element Child Element(s)
Stinrg 1..1 error_message None

faultstring

エラーメッセージ。

Data Type Cardinality Parent Element Child Element(s)
Stinrg 1..1 error_message None

Example of Response


{
    "error_message": {
        "debuginfo": null,
        "faultcode": "Client",
        "faultstring": "Invalid input for field/attribute limit. Value: 'a'. unable to convert to int"
    }
}