フリーワードでの路線情報検索
API名:
railroad/word
概要:
リクエストパラメータで指定される名称を元に該当する路線を返却します。
station/word, station/latlon と組合せて使用できます。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/railroad/word
<API使用例>
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 |
|---|---|---|---|
| word | ○ | - |
検索ワード 検索語句を指定します。 検索語句の上限は1024文字です。 本項目は必須項目であるため、未指定の場合はエラーとなります。 |
| addrcode | - |
絞込み住所コード 検索範囲を指定の住所コードに限定します。 市区町村までのコード（2桁または5桁）を指定できます。 複数指定ができますが、市区町村を指定する場合は同一都道府県に限定されます。 |
|
| limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0～10000 です。 10001 以上の指定をした場合は10000 指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
出力データ
出力フォーマット
| キー名 | データ型 | 説明 | |
|---|---|---|---|
| status | object | ステータス情報が入ります。 | |
| info | object | 検索結果の情報が入ります。 | |
| hit | number | 入力された条件に対してヒットした件数が入ります。 | |
| item | array | 検索結果の路線情報の配列が入ります。検索結果が0件の場合は空の配列となります。 | |
出力例
[通常出力例]
[検索結果が0件の例]
"text":"OK"},
"info":{"hit":0},"item":[]}