2013/12/9 1 / 1 インターフェース 仕 様 書 第 1.0 版 東 京 大 学, 株 式 会 社 リマージュアーツ
2013/12/9 1 / 2 1 オープンデータ 1.1 オープンデータ 取 得 概 要 オープンデータ 取 得 API /opendata/(:(.:format)) /opendata/od(:(_:date)(.:format)) オープンデータとしてまとめられている 場 所 リストを 返 却 する 1.1.1 パラメータ オープンデータ 出 力 フォーマット 日 付 パラメータ 名 format date 必 須 データ 型 integer オープンデータを 一 意 に 特 定 するための 値 出 力 フォーマットを 指 定 ( 未 指 定 の 場 合 は html ) 拡 張 子 フォーマット 文 字 コード string html html5 UTF-8 kml kml UTF-8 json GeoJSON UTF-8 csv excel 互 換 SJIS string ダウンロード 時 のファイル 名 として 使 用 する(APIとしては 無 視 される) 1.1.2 返 却 値 オープンデータメタ 情 報 metadata ( 読 み) 説 明 文 ライセンス 作 成 日 時 更 新 日 時 物 理 名 必 須 データ 型 データソース 繰 り 返 し:1 回 のみ integer opendata name string opendata kana string opendata description text opendata data_creator string opendata license string opendata note string opendata created_at datetime opendata updated_at datetime opendata オープンデータの オープンデータ オープンデータ の 読 み(ひらがな) オープンデータの 説 明 文 オープンデータを 作 成 した 団 体 部 署 人 オープンデータのライセンス 以 下 の 提 供 データを 参 照 し 座 標 付 与 基 盤 を 使 用 して 作 成 されました \r\nhttp://geocoding.tky1.biz//licenses オープンデータの 作 成 日 時 (システムによって 自 動 的 に 付 与 される) オープンデータの 更 新 日 時 (システムによって 自 動 的 に 付 与 される) 場 所 情 報 座 標 繰 り 返 し: 0-1000 name coordinates integer string geometry 場 所 場 所 ( 地 名 施 設 名 等 ) 場 所 の 座 標 表 現 ( coordinate ( 経 度, 緯 度 ) ) 1.1.3 レスポンスステータス ステータスコード 200 400 404 500 ステータスメッセージ OK Bad Request Not Found Internal Server Error 正 常 不 正 なパラメータが 渡 された 場 合 指 定 されたIDが 存 在 しない 場 合 閲 覧 権 限 がない 場 合 例 外 発 生 により 処 理 が 継 続 できない 場 合 1.1.4 リクエストサンプル /opendata/1234 /opendata/1234.json /opendata/1234.kml /opendata/od1234_20131122.csv IDのみ(html 形 式 で 返 却 ) フォーマット 指 定 (GeoJSON 形 式 で 返 却 ) フォーマット 指 定 (KML 形 式 で 返 却 ) ファイル 名 指 定 (ダウンロードファイル 名 をユニークにしたい 場 合 に 使 用 ) 1.1.5 返 却 上 限 件 数 : 1000 件 データ 型 : ruby on rails の 型 に 準 拠
2013/12/9 2 / 2 1.2 レスポンスサンプル サンプルKML サンプルGeoJSON サンプルCSV "type": "FeatureCollection", "metadata": "": 435, "name": " 災 害 時 避 難 場 所 ", "kana": "", "description": " 災 害 の 種 類 によっては 避 難 場 所 が 異 な る 場 合 もありますのでご 注 意 ください", "data_creator":" 浦 安 市 ", "license":"cc0", "note":" 以 下 の 提 供 データを 参 照 し 座 標 付 与 基 盤 を 使 用 して 作 成 されました \r\nhttp://geocoding.tky1.biz//licenses", "created_at": "2013-10-31T10:32:33.722Z", "updated_at": "2013-10-31T10:32:33.723Z" "features": [ "geometry": 139.8923894, 35.65673424 "properties": "": 39035, "name": " 南 小 学 校 地 区 児 童 育 成 クラブ 分 室 " "geometry": 140.1508700583496, 35.60328155205004 "properties": "": 29438, "name": " 葛 城 中 学 校 : <?xml version="1.0" encoding="utf-8"?> <kml xmlns="http://earth.google.com/kml/2.2"> <Document> <name> <![CDATA[スキー 場 > </name> <description> <![CDATA[ 全 国 のスキー 場 のリスト 規 模 が 大 きく 有 名 な 箇 所 大 規 模 な 大 会 の 会 場 となった 箇 所 > </description> <styleurl>#meta-style</styleurl> <Style ="meta-style"> <BalloonStyle><text> <![CDATA[ <h2>スキー 場 </h2> <h4> 全 国 のスキー 場 のリスト 規 模 が 大 きく 有 名 な 箇 所 大 規 模 な 大 会 の 会 場 となった 箇 所 </h4> <table><tr><th>id</th><td>8</td></tr> <tr><th> </th><td> 日 本 ウィンタースポーツ 協 会 </td></tr> <tr><th>ライセンス</th><td>cc0</td></tr> <tr><th> </th><td> 以 下 の 提 供 データを 参 照 し 座 標 付 与 基 盤 を 使 用 して 作 成 されました http://geocoding.tky1.biz//licenses</td></tr> <tr><th> 作 成 日 </th><td>2013-12-09t10:07:46z</td></tr> <tr><th> 更 新 日 </th><td>2013-12-09t10:07:46z</td></tr> </table>></text> </BalloonStyle> </Style> <ExtendedData> <Data name="od_"> 8 <Data name="kana"> <![CDATA[> <Data name="data_creator"> <![CDATA[ 日 本 ウィンタースポーツ 協 会 > <Data name="license"> <![CDATA[CC0> <Data name="note"> <![CDATA[ 以 下 の 提 供 データを 参 照 し 座 標 付 与 基 盤 を 使 用 して 作 成 されました http://geocoding.tky1.biz//licenses> <Data name="created_at"> 2013-12-09T10:07:46Z <Data name="updated_at"> 2013-12-09T10:07:46Z </ExtendedData> <Placemark> <name> <![CDATA[ニセコアンヌプリ 国 際 スキー 場 > </name> <ExtendedData> <Data name="p_"> <displayname>id</displayname> <>19887</> </ExtendedData> <Point> <coordinates>139.91457968261716,35.6580986655828</coordinates> </Point> </Placemark> </Document> </kml>, 場 所 名, 経 度, 緯 度 8516,ニセコアンヌプリ 国 際 スキー 場,140.64771938428748,42.84916324036368 8517, 安 比 高 原,140.96821116982028,40.00210894401827 8518, 志 賀 高 原 サンバレースキー 場,138.48712921142578,36.71425617316473
2013/12/3 1 / 3 2 地 名 辞 書 2.1 施 設 情 報 取 得 概 要 地 名 情 報 取 得 API //(:(.:format)) を 指 定 して 場 所 情 報 を 返 却 する 2.1.1 パラメータ 場 所 情 報 出 力 フォーマット パラメータ 名 必 須 データ 型 integer format string 場 所 情 報 を 一 意 に 特 定 するための 値 出 力 フォーマット json のみ 指 定 可 能 ( 未 指 定 の 場 合 は html) 拡 張 子 フォーマット 文 字 コード html html5 UTF-8 json GeoJSON UTF-8 2.1.2 返 却 値 物 理 名 必 須 データ 型 データソース 場 所 情 報 繰 り 返 し:1 回 のみ integer name string ( 読 み) kana string 座 標 coordinates geometry 情 報 ソース( 提 供 元 ) data_creator string 情 報 ソース( 作 成 日 ) data_date datetime ライセンス license string 作 成 日 時 created_at datetime 更 新 日 時 updated_at datetime 場 所 場 所 ( 地 名 施 設 名 等 ) 場 所 の 読 み(ひらがな) 場 所 の 座 標 表 現 ( coordinate ( 経 度, 緯 度 ) ) 場 所 情 報 の 提 供 元 場 所 情 報 が 作 成 された 日 付 場 所 情 報 のライセンス 場 所 レコードの 作 成 日 時 (システムによって 自 動 付 与 されるため 変 更 不 可 ) 場 所 レコードの 更 新 日 時 (システムによって 自 動 付 与 されるため 変 更 不 可 ) 2.1.3 レスポンスステータス ステータスコード 200 400 404 500 2.1.4 リクエストサンプル ステータスメッセージ OK Bad Request Not Found Internal Server Error 正 常 不 正 なパラメータが 渡 された 場 合 指 定 されたIDが 存 在 しない 場 合 例 外 発 生 により 処 理 が 継 続 できない 場 合 //1234 IDのみ(html 形 式 ) //1234.json 出 力 フォーマット 指 定 (GeoJSON 形 式 ) 2.1.5 返 却 上 限 件 数 : 1000 件
2013/12/3 2 / 3 2.2 地 名 辞 書 検 索 概 要 地 名 辞 書 検 索 API //search?query=query 場 所 の 一 部 をキーに 検 索 を 行 う 2.2.1 パラメータ 検 索 文 字 列 パラメータ 名 query 必 須 型 string 検 索 したい 場 所 の 一 部 (または 全 て)をUTF-8 形 式 の Encode して 入 力 半 角 スペースで 区 切 ることにより 複 数 の 候 補 をAND 検 索 する 出 力 は json (UTF-8) のみ 2.2.2 返 却 値 場 所 情 報 ( 読 み) 座 標 情 報 ソース( 提 供 元 ) 情 報 ソース( 作 成 日 ) ライセンス 作 成 日 時 更 新 日 時 物 理 名 必 須 型 繰 り 返 し: 0-1000 integer name string kana string coordinates geometry data_creator string data_date datetime license string created_at datetime updated_at datetime データソース 場 所 場 所 ( 地 名 施 設 名 等 ) 場 所 の 読 み(ひらがな) 場 所 の 座 標 表 現 (coordinate ( 経 度, 緯 度 ) ) 場 所 情 報 の 提 供 元 場 所 情 報 が 作 成 された 日 付 場 所 情 報 のライセンス 場 所 レコードの 作 成 日 時 (システムによって 自 動 付 与 されるため 変 更 不 可 ) 場 所 レコードの 更 新 日 時 (システムによって 自 動 付 与 されるため 変 更 不 可 ) 2.2.3 レスポンスステータス ステータスコード ステータスメッセージ 200 OK 正 常 400 Bad Request 不 正 なパラメータが 渡 された 場 合 404 Not Found 指 定 されたIDが 存 在 しない 場 合 閲 覧 権 限 がない 場 合 500 Internal Server Error データベース 接 続 エラーなど 2.1.4 リクエストサンプル //search?query= 浦 安 + 高 等 学 校 浦 安 と 高 校 の2 語 が 含 まれている 地 名 を 検 索 2.2.5 返 却 上 限 件 数 :1000 件
2013/12/3 3 / 3 2.3 レスポンスサンプル サンプルJSON (//1234.json) サンプルJSON (//search?query= 浦 安 + 高 等 学 校 ) "type": "FeatureCollection", "features": [ "geometry": 139.908199, 35.660744 "properties": "": 31553, "name": " 県 立 浦 安 高 等 学 校 ", "kana": null, "data_creator": " 国 土 数 値 情 報 ", "data_date": "2013-10-22T09:20:34.034Z", "license": "CC0", "created_at": "2013-10-22T09:20:34.034Z", "updated_at": "2013-10-22T09:20:34.034Z" "type": "FeatureCollection", "features": [ "geometry": 139.9169347, 35.62998231 "properties": "": 36386, "name": " 千 葉 県 立 浦 安 南 高 等 学 校 ", "kana": null, "data_creator": " 浦 安 市 ", "data_date": "2013-10-22T09:23:37.713Z", "license": "CC-BY-SA", "created_at": "2013-10-22T09:23:37.713Z", "updated_at": "2013-10-22T09:23:37.713Z" "geometry": 139.9129413, 35.64002915 "properties": "": 36377, "name": " 学 校 法 人 鎌 形 学 園 東 京 学 館 浦 安 高 等 学 校 東 京 学 館 浦 安 中 学 校 ", "kana": null, "data_creator": " 浦 安 市 ", "data_date": "2013-10-22T09:23:37.670Z", "license": "CC-BY-SA", "created_at": "2013-10-22T09:23:37.671Z", "updated_at": "2013-10-22T09:23:37.671Z" :