ゴミ分別Bot仕様書

第3回オープンデータアプリコンテストに出展した「みんなで育てるゴミ分別案内ボット」の仕様書です．

Transcript

1. ゴミ分別 LINE Bot 仕様書 2017/11/15
2. LINE BOT
3. このメッセージが送信されたら 現在の会話は破棄される LINE 返答パターン一覧 BOTメッセージ ユーザーメッセージ （挨拶メッセージ） システム操作 友達追加 【分別しらべたい】 【明日は何ゴミ？】 （その他のメッセージ） どんなものですか？ CD 回答があるか Yes No CDは燃えないゴミです 地区が登録されているか Yes No 次の回収日は来週の 火曜日です 地区を登録すると 回収日をお知らせします CDは捨て方が 登録されていません 似た単語を入力して みてください 地区が登録されているか Yes No 地区が登録されて いません 【地区を登録・変更】 明日は燃えるゴミ・ 不燃ゴミの回収日です 【回収カレンダー】 以下の表の該当する数字 またはお住まいの住所を 送信してください （地区対応表） 正しい数値かどうか Yes No （5374風カレンダー） 正しい住所かどうか Yes No 常盤台で登録しました 宇部市常盤台 入力が無効でした 下のパネルを 押してください
4. LINE 分別方法検索のデータフロー BOTメッセージ ユーザーメッセージ バックエンド処理 【分別しらべたい】 API Server (Rails) どんなものですか？ データベース処理 メッセージ判定 CD メッセージ判定 分別方法問い合わせ 分別方法がある 分別方法がない 分別方法は〇〇 分別方法のなかった アイテムを登録 似たフレーズで 再度お試しください ステータスはそのまま ステータス更新 アイテムを登録 未回答アイテムを データベースに登録 分別方法取得 データベースから 分別方法を取得 解析に登録
5. Admin Dashboard
6. 画面遷移なし 画面遷移なし 管理画面ルーティング 画面 モーダル ログイン ログイン ログアウトしますか？ はい ホーム 新規関連付け 解析 登録内容一覧 ログアウト 新規関連付け 未回答の問合せリスト 関連付け 除外 関連付け 分別方法一覧 選択 分別方法追加 アイテムを除外 しますか？ はい いいえ 関連付け処理 アイテム一覧 登録アイテムリスト 追加 修正 分別方法一覧 分別方法リスト 追加 修正 登録・更新処理
7. API 仕様
8. API仕様 必要なリクエストとレスポンス 必要なリクエストとレスポンス このサービスを実現するために必要なリクエストとそのレスポンスデータです リクエスト元 リクエスト状況 API URI レスポンス内容 備考 LINE Bot ユーザーから送信されたアイテムがどのような分別方法か GET: /trush/separation 《分別方法が登録されている場合》分別方法を返す 《除外されたアイテムの場合》エラーを返す 《分別方法が登録されていない場合》エラーを返す 存在しないアイテムだった場合、アイテムを登録 PUT: /trush 《成功した場合》Success　《失敗した場合》Failure ユーザーが地区を登録しているかどうか Boolean 指定されたゴミの回収日がいつか 《回収日が存在するゴミの場合》次の回収日を返す 《回収日が存在しないゴミの場合》エラーを返す 明日回収のゴミを取得する Array< 回収するゴミの名前 > 全てのゴミの次の回収日を取得 Array< 回収するゴミの名前 => 回収日 > 地区と数字の対応表を取得 Array< 数値 => 地区名 > ユーザーの地区を更新する 《更新に成功した場合》Success 《更新に失敗した場合》Failure 管理画面 未回答の問い合わせを問い合わせ件数が多い順でソートした一覧を取得 Array<> アイテムに分別方法を関連付けする POST: /trush 《成功した場合》Success　《失敗した場合》Failure アイテムを分別から無効化する PORT: /trush/invalidation 《成功した場合》Success　《失敗した場合》Failure 分別方法を新規に追加する PUT: /separation 《成功した場合》Success　《失敗した場合》Failure 分別方法を更新する PORT: /separation 《成功した場合》Success　《失敗した場合》Failure 分別方法をひとつにまとめる POST: /separation/merge 《成功した場合》Success　《失敗した場合》Failure アイテムを新規に追加する PUT: /trush 《成功した場合》Success　《失敗した場合》Failure アイテムを更新する POST: /trush 《成功した場合》Success　《失敗した場合》Failure アイテムを他のアイテムと紐付ける POST: /trush/tying 《成功した場合》Success　《失敗した場合》Failure
9. 仕様書レイアウト一覧 改変禁止
10. 見出し１ 見出し２ スクリーン名 説明
11. 一般利用者画面 画面詳細仕様 スクリーン名 説明 NO 項目名 要素の形式 説明 遷移先 バリデーション 表示条件 アクション
12. 店舗管理画面 サンプル画面要素一覧 入力欄の説明 入力欄 ボタン ボタン ボタン セレクトボックス 選択ボックス 駐車場 さつき会駐車場 駐車区画 さ-10 備考 19:00〜予約あり テーブル ホーム 入庫 出庫 ポイントログ その他の機能 ログアウト ホーム 入庫 出庫