🚑
クエリAPIを中心に公開APIのエラーメッセージを修正しました
概要
クエリAPI(, )で返却されるエラーメッセージの不具合を修正しました。以前は や の形式でしたが、エラーの内容に合わせて日本語でエラーメッセージが返却されるようになりました。
クエリAPI固有の改善
クエリAPI( ほか)のリクエストや検索条件の誤りに対する応答です。レスポンスボディ内の波括弧内(対象のIDなど)は、エラーの対象に応じて入る値です。
| 操作または条件 | 修正前 | 修正後 |
|---|---|---|
| 基準日を不正な形式で指定する | ||
| 期間の開始日・終了日を不正な形式で指定する | / | |
| 対象データの種別に対応しない値を指定する | ||
| 取得件数・取得開始位置に整数以外を指定する | / | |
| 検索条件の値が項目の型と合っていない | ||
| 検索条件に指定した値を項目の型へ変換できない | ||
| 項目に使用できない演算子を検索条件で指定する |
公開API共通の改善
クエリAPIで発生するエラーを、公開API全体で共通的に扱える形で日本語の文面と適切なステータスコードへ整える処理を追加しました。この処理は公開API全体に適用され、対象としたエラーは公開APIのどのエンドポイントで発生しても同じ形式で返ります。対象としたエラーの範囲は本文末尾の注意点を参照してください。
| 操作または条件 | 修正前 | 修正後 |
|---|---|---|
| 指定した項目が見つからない | / | |
| 指定した選択肢が見つからない | ||
| 指定したエンティティが見つからない | ||
| サーバー側で保持するデータに不整合があり検索結果を組み立てられない |