APIが返すHTTPステータスコードと例外オブジェクトの返却

APIが返し得るHTTPステータスコードは、以下のとおり、API種別毎に決まります。

コード	意味(W3C)	意味(製品)	id特定 (GET)	検索 (GET)	登録 (POST)	削除(DEL)
200	OK	処理成功	○	○		○
201	Created	生成処理成功			○
400	Bad Request	リクエスト違反	○	○	○	○
404	Not Found	リソースがない	○			○
412	Precondition Failed	オプティミスティック同時実行制御による拒絶				○
500	Internal Server Error	その他のエラー	○	○	○	○

ポイント

上記ステータスコードは、Interstage AR Processing Serverが返すコードです。以下のようなコードはInterstage AR Processing Serverではなく、WEBサーバ/JavaEE実行環境が返す場合があります。
- 「401 Unauthorized」等のHTTPの正常系ステータスコード。
- HTTPメッセージフォーマット/パスフォーマット/JSONフォーマット/値型違反を表す400/500番台の異常系ステータスコード

上記ステータスコードのうち、200番台以外で返る場合は、レスポンスボディに、以下のような例外情報が入ります。例外情報につきましては、マニュアル「メッセージ集」を参照してください。

説明	例
JSON形式の例外オブジェクト。 class 例外 { String message; } messageは、メッセージ出力形式のコンポーネント名以降の出力と同じ。	{"message":"QDWEB: ERROR: 13201: QType does not exist."}

説明

例

JSON形式の例外オブジェクト。

class 例外 {
String message;
}

messageは、メッセージ出力形式のコンポーネント名以降の出力と同じ。

{"message":"QDWEB: ERROR: 13201: QType does not exist."}

2.1.2.1 APIが返すHTTPステータスコードと例外オブジェクトの返却