Appearance
API-001-6 期間内機種名一覧
概要
ブロックエディタの期間差枚サマリ(period_samai_summary)用に、指定期間・ホールでデータがある機種名一覧を返す。管理画面向け。
入力(リクエスト)
| param | 必須 | 型・制約 | 説明 |
|---|---|---|---|
period_start | いいえ※ | 空または YYYYMMDD(8 桁数字) | 集計開始日 |
period_end | いいえ※ | 空または YYYYMMDD(8 桁数字) | 集計終了日 |
hall | いいえ※ | string(日本語ホール名) | 対象ホール(例: アイランド秋葉原) |
※ args 上はすべて任意。欠落・空のときはハンドラが 200 + kishuNames: [](ソフトフェイル)。空以外で日付形式不正は args 検証で 400(下表どおり)。期間不正・期間過長・未知ホールはサービス側で空配列。
出力(レスポンス)
成功時 data
| field | 型 | 説明 |
|---|---|---|
kishuNames | array | { name: string, count: int }[]。該当なし・パラメータ不足時は []。success フラグはなし |
HTTP ステータス: 200(ソフトフェイル含む)
失敗・エラー条件
| 条件 | レスポンス形式 |
|---|---|
パラメータ形式不正(args の validate 失敗) | WordPress REST 標準(400 等) |
| 未ログイン・nonce 不正 / 権限不足 | 401 / 403 |
| 業務上の空結果 | { "kishuNames": [ ] }(200。エラーにしない) |
権限・nonce
名前空間共通事項は API-一覧 を参照。本エンドポイントは PeriodSamaiKishuNamesHandler + WordPressDailyArticleBotPermissionChecker(edit_daily_articles。nonce は検証しない)を使用する。管理画面のブロックエディタ(Cookie + wp_rest nonce)と日別記事編集bot(アプリケーションパスワード)の両方から呼ぶ。Cookie 認証で nonce が無いリクエストは WordPress コアが未ログイン扱いにするため 401 になる。AsyncLoadingHandler の IP レート制限は適用しない。
旧 WordPressDailyArticleAdminPermissionChecker からの挙動の違い(#3872 で切り替え):
| 項目 | 旧(Admin Checker) | 現在(Bot Checker) |
|---|---|---|
| nonce が無い Cookie リクエスト | 403(AUTH_FAILED) | 401(LOGIN_REQUIRED。WordPress コアが未ログイン扱いにする) |
| nonce が不正な Cookie リクエスト | 403 | 403(WordPress コアの rest_cookie_invalid_nonce) |
Local バイパス(LocalRestBypassGuard) | 効かない | 効く(ローカルで SLOT_KOURYAKU_ALLOW_LOCAL_REST_BYPASS をオプトインしたときだけ) |
編集画面の JS はステータスコードで分岐していないため、401 / 403 の違いは画面に影響しない。