路線オートコンプリート

/transport_link/autocomplete [GET]

基本情報

概要

指定したワードに対する路線名の自動補完候補を取得します。

URL

https://{HOST}/{CID}/v1/transport_link/autocomplete

※APIマーケットの場合はURL体系が異なります

出力形式

JSON

対応言語

ja

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
word	✔	検索ワード	文字列		最小：2文字最大：50文字	検索したい路線名称アラビア数字・漢数字はそのまま検索します
word_match		検索方法	文字列	prefix		ワードの検索方法 prefix : 前方一致 partial : 部分一致
type		出力する交通機関	文字列		交通機関タイプより指定	ピリオド区切りで複数指定できます出力する路線の種別を限定したい場合にご利用ください（未指定の場合は全種別が検索されます）バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
coord		検索地点	カンマ区切りの数値			検索を行う基準地点の緯度経度・「緯度,経度」の順で指定・ミリ秒表記、度表記(10進数)に対応 coordパラメータ指定時には指定した緯度経度からの距離順に返却されます
radius		検索範囲の半径(単位 : m)	数値	10000	最大値：100000	coord指定時のみ有効
bus_data		バスデータ利用情報	文字列		timetable : バスデータを利用するかどうかのフラグ	バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
datum		緯度経度の測地系	文字列	wgs84	wgs84：世界測地系 tokyo：旧日本測地系

type（交通機関タイプ）

'type' は以下の文字列を取り得ます。

文字列	概要	備考
train	鉄道
airplane	飛行機
ferry	フェリー
shuttle_bus	空港連絡バス
bus	路線バス	路線バスの情報取得は、オプション機能のため、別途契約が必要となります
highway_bus	高速バス	高速バスの情報取得は、オプション機能のため、別途契約が必要となります

データの出力件数について

当APIでは、出力件数が一律20までとなります。

パラメータ構成例

「とうｋ」で始まる路線名称の候補を検索

/transport_link/autocomplete?word=とうｋ

「とうk」で始まる高速バスの路線名称の候補を検索

/transport_link/autocomplete?word=とうk&type=highway_bus&bus_data=timetable

レスポンス

名称	レスポンス名	型名	配列	Nullable	説明
路線情報	items	Linkオブジェクト	〇		路線情報のまとまり

Linkオブジェクト

名称	レスポンス名	型名
路線ID	id	文字列
路線の名称	name	文字列
路線のタイプ	type	文字列
運行会社情報	company	Companyオブジェクト

Companyオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
運行会社ID	id	文字列
運行会社の名称	name	文字列

レスポンス例

{
    "items": [
        {
            "id": "00000766",
            "name": "東京メトロ丸ノ内線",
            "type": "train",
            "company": {
                "id": "00000113",
                "name": "東京地下鉄（メトロ）"
            }
        },
        {
            "id": "00000768",
            "name": "東京メトロ銀座線",
            "type": "train",
            "company": {
                "id": "00000113",
                "name": "東京地下鉄（メトロ）"
            }
        },
        ・・・
    ]
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: word: ['required field']	必須パラメータである word が指定されていない、または空文字の場合に発生します。
400	parameter error: word: ['min length is 2']	word が2文字未満の場合に発生します。
400	parameter error: word: ['max length is 50']	word が50文字を超える場合に発生します。
400	parameter error: word_match: ['an invalid item: {value}']	word_match にピリオド区切りで prefix, partial 以外の不正な値を指定した場合に発生します。
400	parameter error: type: ['an invalid item: {value}']	type にピリオド区切りで train, airplane, ferry, shuttle_bus, bus, highway_bus 以外の不正な値を指定した場合に発生します。
400	parameter error: coord: ['an invalid coordinate : {value}']	coord が「緯度,経度」形式でない場合、または緯度と経度で表記（度表記／ミリ秒表記）が異なる場合に発生します。
400	parameter error: coord: ['an invalid latitude : {value}']	coord に指定した緯度が不正な場合に発生します。
400	parameter error: coord: ['an invalid longitude : {value}']	coord に指定した経度が不正な場合に発生します。
400	parameter error: radius: ['min value is 0']	radius に0未満の値を指定した場合に発生します。
400	parameter error: radius: ['max value is 100000']	radius に100000を超える値を指定した場合に発生します。
400	parameter error: radius: ["field 'coord' is required"]	coord を指定せずに radius のみを指定した場合に発生します。
400	parameter error: bus_data: ['unallowed value {value}']	bus_data に timetable 以外の不正な値を指定した場合に発生します。
400	parameter error: datum: ['unallowed value {value}']	datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。
400	bad usage on this contract　:　bus_data	bus_data を指定したが、契約でバスデータ利用オプションが有効化されていない場合に発生します。
400	bad usage on this contract　:　use_company and unuse_company must be either.	契約の運行会社設定に不整合がある場合に発生します。