line

路線検索

路線検索を行います。

・路線フリーワード検索
　入力された文字列から該当する路線を検索します。
・路線リスト取得
　路線コード、運行系統コード、鉄道会社コードに該当する路線情報を検索します。

https://[domain]/search/line

HTTP request method

POST/GET

ContentType

application/x-www-form-urlencoded

Parameters

名前 説明
word
string		 名称、読みを指定
複数ワードはスペース区切りで指定してください。AND検索となります。
最大文字数 1024
word_match_type
integer
default 3		 検索語句のマッチタイプを指定
  • 1

    完全一致

  • 2

    前方一致

  • 3

    部分一致
line_code
integer		 路線コードを指定
路線を一意に識別するコード
最小値
0
最大値
2147483647
company_code
integer		 鉄道会社コードを指定
鉄道会社を一意に識別するコード
最小値
0
最大値
2147483647
sort
array[string]
default line_code		 出力順を指定(複数指定可)
デフォルトは昇順です。降順指定の場合、ソートキーの前方にマイナス(-)を付加してください。
line_code
路線コード
line_name_read
路線名称読み
company_code
鉄道会社コード
company_name_read
鉄道会社名称読み
limit
array[integer]
※カンマ区切り
default List[0,100]		 検索結果取得件数を指定
"オフセット,件数"で指定してください。
最大値 2000,1000

Responses

エラーについては「エラーメッセージ一覧」を参照してください。

Media type:application/json

キー名 説明
status
string		 ステータス
result info hit
integer		 検索結果総数
item company_code
integer		 鉄道会社コード
company_name
string		 鉄道会社名称
company_name_read
string		 鉄道会社名称読み
line_code
integer		 路線コード
line_name
string		 路線名称
line_name_read
string		 路線名称読み
disp_line_name
string		 表示用路線名称

Example

リクエストURL 
https://[domain]/search/line?word_match_type=3&limit=0,100
 レスポンス 
{
  "status": "OK",
  "result": {
      "info": {
          "hit": 622
      },
      "item": [
          {
              "company_code": 1,
              "company_name": "ＪＲ北海道",
              "company_name_read": "ジェイアールホッカイドウ",
              "line_code": 100001,
              "line_name": "函館本線",
              "line_name_read": "ハコダテホンセン",
              "disp_line_name": "ＪＲ 函館本線"
          },
          ...
      ]
  }
}