交通機関会社ID検索

/transport_company/id [GET]

基本情報

概要

交通機関会社IDを指定して交通機関会社情報を取得します。

URL

https://{HOST}/{CID}/v1/transport_company/id

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

出力形式

JSON

対応言語

ja

パラメータ

パラメータ名	必須	概要	型名	上下限/選択値	備考
id	✔	交通機関会社ID	文字列		ピリオド区切りで複数指定可能です
bus_data		バスデータ利用情報	文字列	timetable：バスデータを利用するかどうかのフラグ	※バス路線の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
options		追加出力情報	文字列	link : 会社が持つ路線の一覧

パラメータ構成例

交通機関会社ID「00000004」と「00000005」の交通機関会社情報を取得

/transport_company/id?id=00000004.00000005

レスポンス

名称	レスポンス名	型名	配列	Nullable	説明
公共交通機関の運行会社情報	items	Companyオブジェクト	〇

Companyオブジェクト

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

レスポンス例

{
    "items": [
        {
            "id": "00000004",
            "name": "ＪＲ東日本"
        },
        {
            "id": "00000005",
            "name": "ＪＲ北海道"
        }
    ]
}

エラー情報

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

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

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: id: ['required field']	必須パラメータである id が指定されていない場合に発生します。
400	parameter error: id: ['min length is 1']	id に空文字を指定した場合に発生します。
400	parameter error: id: ['max length is 50']	id が50文字を超える場合に発生します（ピリオド区切りを含む全体の文字数です）。
400	parameter error: bus_data: ['unallowed value {value}']	bus_data に timetable 以外の不正な値を指定した場合に発生します。
400	parameter error: options: ['unallowed value {value}']	options に link 以外の不正な値を指定した場合に発生します。
400	bad usage on this contract　:　bus_data	bus_data を指定したが、契約でバスデータ利用オプションが有効化されていない場合に発生します。
400	bad usage on this contract　:　invalid id	id に契約で利用が許可されていない交通機関会社IDを指定した場合に発生します。
400	bad usage on this contract　:　use_company and unuse_company must be either.	契約の運行会社設定に不整合がある場合に発生します。