鉄道路線コードでの駅POI検索
API名:
概要:
リクエストパラメータの鉄道路線コードから、駅情報を取得します。
※多言語情報の出力には別途契約が必要です。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/station/railroad
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/station/railroad?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&linecode=0520
リクエストパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
linecode | ○ | - |
路線コード 路線コードを指定します。 本項目は必須項目であるため、未指定の場合はエラーとなります。 |
||||||||||
word | - |
絞り込み駅名称 駅名称での絞り込みを指定します。(カナ指定可) 上限1024文字です。 複数語句での検索はできません。 |
|||||||||||
addrcode | - |
絞り込み住所コード 検索範囲を指定の住所コードに限定します。 市区町村までのコード(2桁または5桁)を指定できます。 複数指定できますが、市区町村を指定する場合は同一都道府県に限定されます。 複数指定時はカンマ区切りで指定します。 |
|||||||||||
sort | -score |
出力順 出力順を指定します。複数値指定できます。 デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス(-)を付加します。
|
|||||||||||
datum | TOKYO |
測地系 返却される住所代表点の測地系を指定します。 |
|||||||||||
llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
|||||||||||
limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0~10000 です。 10001 以上の指定をした場合は10000 指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|||||||||||
notmultilanguage | F |
多言語情報出力 検索結果に多言語情報を含まないかを真偽値で指定します。 本パラメータはオプション機能で多言語機能を選択されているクライアントIDのみ有効です。
|
出力データ
出力フォーマット
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":1}, "item":[{"poi":{"text":""新橋駅(JR 山手線)", "code":"20000000000000003575", "point":{"lat":35.6633583, "lon":139.7613556}, "kana":"シンバシエキ", "addressText":"東京都港区新橋2丁目17-14", "zipcode":"105-0004", "phoneNumber":"050-2016-1600", "genre":{"code": string, "text": string}, "detail":{"areaid":string, "areaname":string, "detailid":string, "detailname":string, "floorname":string, "level":string}, "language": {"zh-cn": {"text": "新桥站(JR山手线)", "addressParts": ["东京都", "港区", "新桥", "2丁目", "17", "14"], "genre": string}, "zh-tw": {"text": "新橋站(JR山手線)", "addressParts": ["東京都", "港區", "新橋", "2丁目", "17", "14"], "genre": string}, "en": {"text": "Shimbashi (JR Yamanote Line)", "addressParts": ["Tokyo", "Minato", "Shinbashi", "2", "17", "14"], "genre": string}, "ko": {"text": "신바시 역(JR 야마노 테선)", "addressParts": ["도쿄도", "미나토 구", "신바시", "2쵸메", "17", "14"], "genre": string}}, "arrivalInfo": [{"text": "日比谷口", "kana": "ヒビヤグチ", "exittype": {"code": "03", "text": "出入口"}, "arrivalpoint": {"lat": 35.6639139, "lon": 139.7605028}, "exitpoint": {"lat": 35.6638472, "lon": 139.7610694}}]}, "line: {"code": "0113", "text": "JR 山手線", "textMulti": {"zh-cn": "JR山手线", "zh-tw": "JR山手線", "en": "JR Yamanote Line", "ko": "JR 야마노 테선"}}}
キー名 | データ型 | 説明 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | object | ステータス情報が入ります。 | |||||||||||||||||
code | string |
ステータスコードが入ります。
|
|||||||||||||||||
text | string | ステータス内容に関するテキスト情報が入ります。 | |||||||||||||||||
info | object | 検索結果の情報が入ります。 | |||||||||||||||||
hit | number | 検索結果総数が入ります。 | |||||||||||||||||
item | array |
検索結果の配列となります。 検索結果が0件の場合は空の配列となります。 |
|||||||||||||||||
poi | object | POI情報が入ります。 | |||||||||||||||||
line | object | 路線情報が入ります。 | |||||||||||||||||
code | string | 路線コードが入ります。 | |||||||||||||||||
text | string | 路線名称が入ります。 | |||||||||||||||||
textMulti | object |
翻訳情報のオブジェクトが入ります。
|
出力例
[通常出力例(多言語情報出力契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/station/railroad?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&linecode=0284&word=北品川駅
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":1}, "item":[{"poi":{"text":"北品川駅(京急本線)", "code":"20000000000000003067", "point":{"lat":35.619325, "lon":139.7425194}, "kana":"キタシナガワエキ", "addressText":"東京都品川区北品川1丁目2", "zipcode":null, "phoneNumber":null, "genre":null, "detail":null, "language":{"zh-cn":{"text":"北品川站(京急本线)", "addressParts":["东京都", "品川区", "北品川", "1丁目", "2"], "genre":null}, "zh-tw":{"text":"北品川站(京急本線)", "addressParts":["東京都","品川區","北品川","1丁目","2"], "genre":null}, "en":{"text":"Kitashinagawa(KeikyuMainLine)", "addressParts":["Tokyo", "Shinagawa", "Kitashinagawa", "1", "2"], "genre":null}, "ko":{"text":"키타시나가와역(케이힌급행전철본선)", "addressParts":["도쿄도", "시나가와구", "키타시나가와", "1쵸메", "2"], "genre":null}}, "arrivalInfo":[{"text":"出入口", "kana":"デイリグチ", "exittype":{"code":"99", "text":"未調査"}, "arrivalpoint":{"lat":35.6187528, "lon":139.742275}, "exitpoint":{"lat":35.6187528, "lon":139.7422778}}]}, "line":{"code":"0284", "text":"京急本線", "textMulti":{"zh-cn":"京急本线", "zh-tw":"京急本線", "en":"KeikyuMainLine", "ko":"케이힌급행전철본선"}}}]}
[通常出力例(多言語情報出力未契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/station/railroad?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&linecode=0284&word=北品川駅
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":1}, "item":[{"poi":{"text":"北品川駅(京急本線)", "code":"20000000000000003067", "point":{"lat":35.619325, "lon":139.7425194}, "kana":"キタシナガワエキ", "addressText":"東京都品川区北品川1丁目2", "zipcode":null, "phoneNumber":null, "genre":null, "detail":null, "language":null, "arrivalInfo":[{"text":"出入口", "kana":"デイリグチ", "exittype":{"code":"99", "text":"未調査"}, "arrivalpoint":{"lat":35.6187528, "lon":139.742275}, "exitpoint":{"lat":35.6187528, "lon":139.7422778}}]}, "line":{"code":"0284", "text":"京急本線", "textMulti":null,}}]}
[検索結果が0件の場合]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/station/railroad?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&linecode=0000
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":0}, "item":[]}