応答メッセージ

Verifyアプリケーションプログラミングインターフェース(API)が返すさまざまなエラーおよび応答メッセージに関する情報。

HTTP 状況コードは、操作が成功したかどうかを示します。 要求を送信し、Verify API から応答を取得したときに、以下のタイプのエラーが返される場合があります。
2xx 成功
操作の成功状況を示します。
4xx クライアント・エラー
クライアント・アプリケーションが送信した要求についての問題を示します。 要求を再送信する前に、要求の問題を修正します。
5xx サーバー・エラー
サーバーについての問題を示します。 要求が成功するまで、要求を再送信または再試行します。
応答の本文には、メッセージ ID (messageId) と、要求者のロケールに変換されるテキスト (messageDescription) が含まれています。
表 1. 応答メッセージ
HTTP 状況コード 説明
200 オブジェクトの取得が成功しました。
201 オブジェクトの作成が成功しました。
202 要求は受け入れられましたが、完了していません (非同期操作)。
204 要求された操作 (オブジェクトの更新や削除など) は成功しました。
207 マルチ・ステータス - 結果が混在して返されました。 このステータスは、PATCH および一括操作で生じる可能性があります。
400 要求が正しくありません。 要求の形式が誤っていたか、要求を処理できません。 入力パラメーターに無効な値が含まれている可能性があります。
401 クライアントが認証されませんでした。 例えば、使用されたアクセス・トークンが無効です。
403 禁止されたアクセスです。 例えば、アクセス・トークンで、要求されたリソースへのアクセスが許可されません。
404 リソースが見つかりませんでした。 要求された情報は存在しません。
405 要求に指定されている HTTP メソッドがリソースでサポートされていません。
406 リソースが、要求の Accept ヘッダーで指定されている表現を生成できません。
409 情報が存在します。
415 リソースが、要求の Content-Type ヘッダーで指定されている表現を取り込むことができません。
429 要求の数が多すぎます
500 要求の処理中に内部サーバー・エラーが発生しました。
501 要求されたメソッドが使用不可にされていました。
502 通知が送信されませんでした。
PATCH 操作中にすべての操作が正常終了した場合、
204
状況が返されます。 1 つ以上のエラーがある場合は 207 状況が返され、クライアントは結果を解析できます。
DELETEや などの POST 一括管理操作中にすべての処理が正常に完了した場合、
201
状況が返されます。 1 つ以上のエラーがある場合は 207 状況が返され、クライアントは結果を解析できます。

エラー処理の場合は、エラー応答本文の HTTP 応答コードと messageId を使用します。 messageDescription は情報にのみ使用され、変更されることがあります。 このような変更は、 API セマンティクスに対する変更には該当しません。