1 / 1 ページ
東京大学, 株式会社 リマージュアーツ
座標変換基盤API 承認 ページ APIインターフェース仕様書 熊谷 潤 2013/12/9 更新日付 座標変換基盤API 作成者 松原 剛 更新者座標変換基盤API インターフェース仕様書
第 1.0 版
1 / 2 ページ
1 オープンデータ
1.1 オープンデータ取得 1.1.1 パラメータ 拡張子 フォーマット 文字コード html html5 UTF-8 kml kml UTF-8json GeoJSON UTF-8
csv excel互換 SJIS 1.1.2 返却値 オープンデータの識別子 オープンデータ名称 オープンデータ名称の読み(ひらがな) オープンデータの説明文 オープンデータを作成した団体、部署、人 オープンデータのライセンス 以下の提供データを参照し座標付与基盤を使用して作成されました。\r\nhttp://geocoding.tky1.biz/places/licenses オープンデータの作成日時 (システムによって自動的に付与される) オープンデータの更新日時 (システムによって自動的に付与される) 1.1.3 レスポンスステータス 1.1.4 リクエストサンプル 1.1.5 備考
note × string opendata
オープンデータメタ情報 metadata ライセンス license name kana 出力フォーマット format × 日付 date /opendata/od1234_20131122.csv 場所情報 places 識別子 フォーマット指定(KML形式で返却) 座標 ページ URL 備考 places string オープンデータを一意に特定するための値 URL /opendata/od(:id(_:date)(.:format)) 出力フォーマットを指定 (未指定の場合は html ) 返却上限件数: 1000件 データ型: ruby on rails の型に準拠 integer 場所識別子 id /opendata/1234 /opendata/1234.json /opendata/1234.kml integer 識別子 名称 name IDのみ(html形式で返却) 備考 オープンデータ取得API /opendata/(:id(.:format)) オープンデータとしてまとめられている場所リストを返却する データソース opendata Not Found opendata opendata ▽ 繰り返し: 0-1000 ○ places OK Bad Request ○ string opendata opendata 備考 フォーマット指定(GeoJSON形式で返却) × opendata 名称 ○ × × opendata string description 500 名称(読み) datetime coordinates × ステータスコード 200 説明文 作成者 備考 ○ ○ 必須 × string × string ダウンロード時のファイル名として使用する(APIとしては無視される) data_creator データ型 ▽ 繰り返し:1回のみ 備考 パラメータ名 データ型 項目名 オープンデータ識別子 必須 項目名 places 座標変換基盤API id 物理名 名称 概要 id updated_at 作成日時 404 ○ 400 正常 不正なパラメータが渡された場合 指定されたIDが存在しない場合。閲覧権限がない場合 場所名称 (地名、施設名等) geometry 熊谷 潤 text created_at ファイル名指定 (ダウンロードファイル名をユニークにしたい場合に使用) 例外発生により処理が継続できない場合 ○ integer opendata 2013/12/9 座標変換基盤API ステータスメッセージ 更新日時 場所の座標表現 ( coordinate ( 経度 , 緯度 ) ) 更新者 datetime 承認 更新日付 string string 作成者 松原 剛 APIインターフェース仕様書
2 / 2 ページ ページ 座標変換基盤API 熊谷 潤 2013/12/9 座標変換基盤API 更新者 更新日付 承認 作成者 松原 剛 APIインターフェース仕様書
1.2 レスポンスサンプル
サンプルKML サンプルGeoJSON サンプルCSV { "type": "FeatureCollection", "metadata": { "id": 435, "name": "災害時避難場所", "kana": "", "description": "※ 災害の種類によっては避難場所が異な る場合もありますのでご注意ください", "data_creator":"浦安市", "license":"CC0", "note":"以下の提供データを参照し座標付与基盤を使用して作成 されました。\r\nhttp://geocoding.tky1.biz/places/licenses", "created_at": "2013-10-31T10:32:33.722Z", "updated_at": "2013-10-31T10:32:33.723Z" }, "features": [ { "type": "Feature", "geometry": { "type": "Point", "coordinates": [ 139.8923894, 35.65673424 ] }, "properties": { "id": 39035, "name": "南小学校地区児童育成クラブ分室" } }, { "type": "Feature", "geometry": { "type": "Point", "coordinates": [ 140.1508700583496, 35.60328155205004 ] }, "properties": { "id": 29438, "name": "葛城中学校 } }, : id,場所名,経度,緯度 8516,ニセコアンヌプリ国際スキー場,140.64771938428748,42.84916324036368 8517,安比高原,140.96821116982028,40.00210894401827 8518,志賀高原サンバレースキー場,138.48712921142578,36.71425617316473 <?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 id="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/places/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_id"> <value>8</value> </Data> <Data name="kana"> <value> <![CDATA[]]> </value> </Data> <Data name="data_creator"> <value> <![CDATA[日本ウィンタースポーツ協会]]> </value> </Data> <Data name="license"> <value> <![CDATA[CC0]]> </value> </Data> <Data name="note"> <value> <![CDATA[以下の提供データを参照し座標付与基盤を使用して作成されました。 http://geocoding.tky1.biz/places/licenses]]> </value> </Data> <Data name="created_at"> <value>2013-12-09T10:07:46Z</value> </Data> <Data name="updated_at"> <value>2013-12-09T10:07:46Z</value> </Data> </ExtendedData> <Placemark> <name> <![CDATA[ニセコアンヌプリ国際スキー場]]> </name> <ExtendedData> <Data name="p_id"> <displayName>ID</displayName> <value> <id>19887</id> </value> </Data> </ExtendedData> <Point> <coordinates>139.91457968261716,35.6580986655828</coordinates> </Point> </Placemark> </Document> </kml>1 / 3 ページ
2 地名辞書
2.1 施設情報取得
2.1.1 パラメータ 拡張子 フォーマット 文字コード html html5 UTF-8json GeoJSON UTF-8
2.1.2 返却値 2.1.3 レスポンスステータス 2.1.4 リクエストサンプル 2.1.5 備考 format × string 出力フォーマット 備考 URL
座標 coordinates ○ geometry places
出力フォーマット json のみ指定可能 (未指定の場合は html) integer 必須 項目名 地名情報取得API /places/(:id(.:format)) 識別子を指定して場所情報を返却する 備考 場所情報を一意に特定するための値 データ型 id ○
Internal Server Error ステータスメッセージ Bad Request × string 情報ソース(提供元) 400 データソース 必須 物理名 データ型 場所情報 places datetime string string datetime integer id name kana 識別子 ▽ 繰り返し:1回のみ × data_creator 404 ライセンス 名称 名称(読み) 情報ソース(作成日) 指定されたIDが存在しない場合 概要 パラメータ名 Not Found data_date license created_at ステータスコード 200 座標変換基盤API 作成者 松原 剛 更新者 熊谷 潤 名称 ページ APIインターフェース仕様書 座標変換基盤API 更新日付 2013/12/3 承認 updated_at 例外発生により処理が継続できない場合 場所識別子 場所名称 (地名、施設名等) 場所名称の読み(ひらがな) 場所の座標表現( coordinate ( 経度 , 緯度 ) ) ○ ○ places places places places 場所情報の提供元 場所情報が作成された日付 場所情報のライセンス 場所レコードの作成日時 (システムによって自動付与されるため変更不可) × places string places places places × ○ ○ 備考 場所レコードの更新日時 (システムによって自動付与されるため変更不可) 不正なパラメータが渡された場合 datetime 正常 500 返却上限件数: 1000件 項目名 場所情報識別子 作成日時 更新日時 OK URL 備考 /places/1234 IDのみ(html形式) /places/1234.json 出力フォーマット指定(GeoJSON形式)
2 / 3 ページ 座標変換基盤API 作成者 松原 剛 更新者 熊谷 潤 ページ APIインターフェース仕様書 座標変換基盤API 更新日付 2013/12/3 承認
2.2 地名辞書検索
2.2.1 パラメータ 2.2.2 返却値 2.2.3 レスポンスステータス 2.1.4 リクエストサンプル 2.2.5 備考 URL 備考 /places/search?query=浦安+高等学校 「浦安」と「高校」の2語が含まれている地名を検索 正常 場所レコードの作成日時 (システムによって自動付与されるため変更不可) 検索したい場所の一部(または全て)をUTF-8 形式の URL Encode して入力半角スペースで区切ることにより複数の候補をAND検索する。 ※ 出力は json (UTF-8) のみ
integer
場所の座標表現(coordinate ( 経度 , 緯度 ) )
404 Not Found 指定されたIDが存在しない場合。閲覧権限がない場合
場所レコードの更新日時 (システムによって自動付与されるため変更不可) ステータスコード ステータスメッセージ 200 備考 場所情報のライセンス 項目名 名称 必須 型 場所名称の一部をキーに検索を行う 備考 ○ string 検索文字列 必須 備考 項目名 パラメータ名 ○ ▽ 繰り返し: 0-1000 型 場所名称 (地名、施設名等) places データソース 物理名
Internal Server Error データベース接続エラーなど
不正なパラメータが渡された場合 400 Bad Request 場所識別子 OK 情報ソース(提供元) 場所情報の提供元 場所情報が作成された日付 返却上限件数:1000件 data_creator query 地名辞書検索API places 名称(読み) 500 概要 id kana 場所名称の読み(ひらがな) 場所情報 places 識別子 名称 × string places places 座標 /places/search?query={query} places name ○ string 更新日時 情報ソース(作成日) places license × string × datetime places places places updated_at ○ string × ○ datetime ライセンス coordinates ○ geometry data_date 作成日時 datetime URL created_at
3 / 3 ページ 座標変換基盤API 作成者 松原 剛 更新者 熊谷 潤 ページ APIインターフェース仕様書 座標変換基盤API 更新日付 2013/12/3 承認