路線会社検索
/transport_link/company [GET]
基本情報
概要
交通機関の会社IDに合致する路線の一覧を取得します。
URL
https://{HOST}/{CID}/v1/transport_link/company
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
出力順
- 路線ID昇順
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| company | ✔ | 交通機関会社ID | 文字列 | 検索をおこなう会社ID | ||
| type | 出力する交通機関 | 文字列 | 交通機関タイプより指定 | ピリオド区切りで複数指定できます 出力する路線の種別を限定したい場合にご利用ください（未指定の場合は全種別が検索されます） バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
||
| options | 追加出力情報 | 文字列 | node：路線に属する駅の一覧 | |||
| sort | 追加出力情報のソート順 | 文字列 | down | up：上り down：下り |
追加出力情報の駅を「上り順」で出力するか「下り順」で出力するかを指定します | |
| offset | データの出力開始位置 | 数値 | 0 | 最小値：0 最大値：1000 |
何件目から表示されるか（1件目が0）を指定します | |
| limit | データの出力件数 | 数値 | 10 | 最小値：1 最大値：100 |
路線データの出力件数 | |
| bus_data | バスデータ利用情報 | 文字列 | timetable：バスデータを利用するかどうかのフラグ | バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
type（交通機関タイプ）
'type' は以下の文字列を取り得ます。
| 文字列 | 概要 | 備考 |
|---|---|---|
| train | 鉄道 | |
| airplane | 飛行機 | |
| ferry | フェリー | |
| shuttle_bus | 空港連絡バス | |
| bus | 路線バス | 路線バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
| highway_bus | 高速バス | 高速バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
パラメータ構成例
- 「JR東日本」が運行する路線情報を10件検索
/transport_link/company?company=00000004
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 検索数 | count | Countオブジェクト | |||
| 路線情報 | items | Linkオブジェクト | 〇 | ||
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Countオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| トータルヒット件数 | total | 数値 | 検索ヒットした件数 | ||
| オフセット値 | offset | 数値 | オフセットが設定されている場合はその値を出力 | ||
| データの出力件数 | limit | 数値 | データの出力件数に設定されている値 1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力 |
Linkオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 路線ID | id | 文字列 | |||
| 路線の名称 | name | 文字列 | |||
| 路線のタイプ | type | 文字列 | nullable | リクエストパラメータ 'type' に指定出来る文字列と同等のものが含まれます | |
| 運行会社情報 | company | Companyオブジェクト | |||
| 共同運行会社情報 | companies | Companyオブジェクト | 〇 | ||
| 路線に属する駅の一覧 | nodes | Nodeオブジェクト | 〇 | nullable | 「options=node」指定時のみ出力されます |
Companyオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 運行会社ID | id | 文字列 | |||
| 運行会社の名称 | name | 文字列 |
Nodeオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 駅/バス停のノードID | id | 文字列 | |||
| 駅/バス停の名称 | name | 文字列 | |||
| 駅/バス停の名称の読み仮名 | ruby | 文字列 | nullable | ||
| ノードタイプ | type | 文字列 | |||
| 住所の表示名 | address_name | 文字列 | |||
| 住所コード | address_code | 文字列 | |||
| 駅/バス停の緯度経度 | coord | Coordinateオブジェクト | 路線固有の緯度経度が存在する場合は、路線及び上り/下りに応じた駅/バス停の緯度経度を返却します | ||
| 駅/バス停の代表緯度経度 | coord_representative | Coordinateオブジェクト | nullable | 株式会社ナビタイムジャパンが独自で算出しています。 バス停については、時刻表や路線図などが提示されている標識板の位置を示します。 |
|
| 駅ナンバリング情報 | numbering | Numberingオブジェクト | 〇 | nullable |
Numberingオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 駅シンボル記号 | symbol | 文字列 | nullable | ||
| 駅番号 | number | 文字列 | nullable |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 緯度 | lat | 数値 | |||
| 経度 | lon | 数値 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 測地系 | datum | 文字列 | nullable | ||
| 緯度経度の出力形式 | coord_unit | 文字列 | nullable |
レスポンス例
{
"count": {
"total": 94,
"offset": 0,
"limit": 10
},
"items": [
{
"id": "00000117",
"name": "ＪＲ伊東線",
"type": "train",
"company": {
"id": "00000004",
"name": "ＪＲ東日本"
},
"companies": [
{
"id": "00000004",
"name": "ＪＲ東日本"
}
],
"nodes": [
{
"id": "00007326",
"name": "熱海",
"ruby": "あたみ",
"type": "station",
"address_name": "静岡県",
"address_code": "22205017000",
"coord": {
"lat": 35.100374,
"lon": 139.080987
},
"coord_representative": {
"lat": 35.100374,
"lon": 139.080987
},
"numbering": [
{
"symbol": "JT",
"number": "21"
}
]
},
{
"id": "00008907",
"name": "来宮",
"ruby": "きのみや",
"type": "station",
"address_name": "静岡県",
"address_code": "22205026000",
"coord": {
"lat": 35.095536,
"lon": 139.068755
},
"coord_representative": {
"lat": 35.095536,
"lon": 139.068755
},
"numbering": [
{
"symbol": "JT",
"number": "22"
}
]
},
・・・
]
}
],
"unit": {
"datum": "tokyo",
"coord_unit": "degree"
}
}
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。
| HTTPステータス | エラーメッセージ | 発生理由 |
|---|---|---|
| 405 | This http method is invalid : POST (等) | 許可されていないHTTPメソッドでアクセスされた場合に発生します。 |
| 400 | parameter error: company: ['required field'] | 必須パラメータである company が指定されていない場合に発生します。 |
| 400 | parameter error: company: ['min length is 1'] | company に空文字を指定した場合に発生します。 |
| 400 | parameter error: type: ['an invalid item: {value}'] | type にピリオド区切りで train, airplane, ferry, shuttle_bus, bus, highway_bus 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: options: ['unallowed value {value}'] | options に node 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: sort: ['unallowed value {value}'] | sort に up, down 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: offset: ['min value is 0'] | offset に0未満の値を指定した場合に発生します。 |
| 400 | parameter error: offset: ['max value is 1000'] | offset に1000を超える値を指定した場合に発生します。 |
| 400 | parameter error: limit: ['min value is 1'] | limit に1未満の値を指定した場合に発生します。 |
| 400 | parameter error: limit: ['max value is 100'] | limit に100を超える値を指定した場合に発生します。 |
| 400 | parameter error: bus_data: ['unallowed value {value}'] | bus_data に timetable 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: datum: ['unallowed value {value}'] | datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: coord_unit: ['unallowed value {value}'] | coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。 |
| 400 | bad usage on this contract : invalid company | company に契約で利用が許可されていない交通機関会社IDを指定した場合に発生します。 |
| 400 | bad usage on this contract : bus_data | bus_data を指定したが、契約でバスデータ利用オプションが有効化されていない場合に発生します。 |
| 400 | bad usage on this contract : use_company and unuse_company must be either. | 契約の運行会社設定に不整合がある場合に発生します。 |