■計画停電検索API v1.00β readme.txt ver1.00 初版 readme.txt ver1.01 システム概要について追記 readme.txt ver1.02 さらに追記 readme.txt ver1.03 レスポンスパラメータ追記 readme.txt ver1.04 連絡先追記 readme.txt ver1.05 HTML版仕様書へ移行 -------------------------------------------------- この readme.txt は更新を終了しました。 最新の情報は http://mukku.org/v1.00/ をご覧下さい。 -------------------------------------------------- 現在、試験運用中です。 後ほど、正式な仕様書を作成します。 ■これは何？ 「地名キーワード」「緯度経度」「郵便番号」のいずれかをリクエストパラメータとして入力すると、 計画停電のグループ番号(1〜5)と、今日の停電時間帯、停電時間帯までの残り時間などをXML形式で取得できます。 更新情報などは「神奈川工科大学情報学部情報メディア学科 速水・服部研究室Twitterアカウント」@hhlab_bot でお知らせいたします。 http://twitter.com/hhlab_bot ■使用データ 東京電力HPにて公開されている計画停電の資料をもとにデータベースを構築しました。 http://www.tepco.co.jp/ ■システム概要 リクエストされた「地名」や「緯度経度」を基にデータベース内から検索を行い、一致するデータがあればXML形式で出力します。 緯度・経度から地名への変換にはYahoo!デベロッパーネットワークで提供されている「リバースジオコーダ」を使用しています。 http://developer.yahoo.co.jp/webapi/map/openlocalplatform/v1/reversegeocoder.html 郵便番号から地名への変換には葵さんの「郵便番号API」を使用しています。 http://api.aoikujira.com/ サーバはロリポップレンタルサーバを利用しています。 http://lolipop.jp/ ■データの更新について 各グループ(1〜5)と停電時間帯の組み合わせは毎日変わります。 このため、毎日午前0時〜3時頃に、各グループと停電時間帯の組み合わせを手動で設定しています。 APIを利用する際は、レスポンスパラメータ内の「DB最終更新日時」が当日の日時になっていることをお確かめ下さい。 ■APIの利用について Webアプリやスマートフォンアプリなどでご自由にお使い下さい。 ただし、データの正確性は保証できませんのでご了承下さい。 緊急時を除き、データベース内のデータの更新は1日1回手動で行っています。 最新の情報は東京電力HPをご覧下さい。 また、リクエスト数に制限などは設けていませんが、常識の範囲内でのご利用をお願いいたします。 (秒単位でのアクセスはお止め下さい。) ■リクエストパラメータ ・必須 input (add か geo か zip いずれか) └ add : 市町村名で検索 └ geo : 緯度経度で検索 └ zip : 郵便番号で検索 inputでaddを指定した場合 city └ UTF-8でURLエンコードされた検索地名キーワード (ex. 厚木市下荻野 → %e5%8e%9a%e6%9c%a8%e5%b8%82%e4%b8%8b%e8%8d%bb%e9%87%8e) inputでgeoを指定した場合 lat └ 緯度 lon └ 経度 datum └ 測位系 (wgs か tky・指定しないとwgs) inputでzipを指定した場合 zn └ 7桁の郵便番号 (ex. 2430292 243-0292) ・オプション output (出力値のタイプ(常にxml・指定しなくても可)) count (出力件数(1から10・指定しないと10件)) ■リクエスト例 ・市町村名で検索 http://mukku.org/v1.00/?input=add&city=%e5%8e%9a%e6%9c%a8%e5%b8%82%e4%b8%8b%e8%8d%bb%e9%87%8e http://mukku.org/v1.00/?input=add&city=%e5%8e%9a%e6%9c%a8%e5%b8%82%e4%b8%8b%e8%8d%bb%e9%87%8e&output=xml http://mukku.org/v1.00/?input=add&city=%e5%8e%9a%e6%9c%a8%e5%b8%82%e4%b8%8b%e8%8d%bb%e9%87%8e&output=xml&count=3 ・緯度・経度で検索 http://mukku.org/v1.00/?input=geo&lat=35.47673&lon=139.346093 http://mukku.org/v1.00/?input=geo&lat=35.47673&lon=139.346093&output=xml http://mukku.org/v1.00/?input=geo&lat=35.47673&lon=139.346093&output=xml&count=3 ・郵便番号で検索 http://mukku.org/v1.00/?input=zip&zn=2430203 http://mukku.org/v1.00/?input=zip&zn=2430203&output=xml http://mukku.org/v1.00/?input=zip&zn=2430203&output=xml&count=3 ■レスポンスパラメータ ResultInfoブロック SearchType ：検索種別 (add か geo か zip) City ：地区名 Lat ：緯度 Lon ：経度 Zip ：郵便番号 Total ：検索ヒット数 Count ：出力件数 Status ：ステータスフラグ (OKのみ) LastUpDate ：DB最終更新日時 (RFC2822フォーマット) LastUpDateEpoch ：DB最終更新日時 (エポック秒) SystemTime ：リクエスト処理日時 (RFC2822フォーマット) SystemTimeEpoch ：リクエスト処理日時 (エポック秒) SystemVersion ：システムバーション Info ：管理者からのお知らせ等 Description ：注意事項等 Copyright ：著作権情報 Resultブロック CityGroupブロック Prefecture ：都道府県名 CityName1 ：市区群名 CityName2 ：大字名 Group ：停電地区グループ番号 Timeブロック All ：停電時間帯の日本語表記 Count ：1日で停電する回数 (0から2) Start ：停電開始時間 (エポック秒) 停電が1日に2回ある場合は半角カンマ(,)区切りで2つの開始時間が並びます End ：停電終了時間 (エポック秒) 停電が1日に2回ある場合は半角カンマ(,)区切りで2つの終了時間が並びます StartRfc ：停電開始時間 (RFC2822フォーマット) 停電が1日に2回ある場合は半角セミコロン(;)区切りで2つの開始時間が並びます EndRfc ：停電終了時間 (RFC2822フォーマット) 停電が1日に2回ある場合は半角セミコロン(;)区切りで2つの終了時間が並びます StartRemaining：停電開始までの残り時間(秒数) すでに過ぎた場合は経過時間(マイナス-がつきます) EndRemaining ：停電終了までの残り時間(秒数) すでに過ぎた場合は経過時間(マイナス-がつきます) ■レスポンス例 http://mukku.org/v1.00/?input=add&city=%e5%8e%9a%e6%9c%a8%e5%b8%82%e4%b8%8b%e8%8d%bb%e9%87%8e add 厚木市下荻野 2 10 OK Wed, 16 Mar 2011 01:29:21 +0900 1300206561 Wed, 16 Mar 2011 04:27:37 +0900 1300217257 1.00β 更新情報などはTwitter @hhlab_bot をご覧下さい。 データの正確性は保証できませんのでご了承下さい Copyright (C) 2011 mukku.org 神奈川県 厚木市 下荻野 1 神奈川県 厚木市 下荻野 4 ■エラー時のレスポンス リクエストパラメータにエラーがあった場合は以下のエラーが返ってきます。 Parameter Error. 1 ■APIについてのお問い合わせ・不具合報告 「神奈川工科大学情報学部情報メディア学科 速水・服部研究室Twitterアカウント」 Twitter @hhlab_bot 宛てにお願いいたします。 http://twitter.com/hhlab_bot