会社情報

会社の情報を取得します。 oldNameに会社の旧名称を指定すると、新名称を取得できます。

GET /v1/{format}/corporation

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキー 。必須
code int 会社コード。コードが割り当てられているのは鉄道会社のみです。prefectureCode, oldNameと排他。省略可。
name string 会社の名称(前方一致)。code, oldNameと排他。省略可。
prefectureCode int 都道府県コード。oldName指定時無効です。複数指定可。省略可。省略時は全ての都道府県を対象とします。
oldName string 会社の旧名称。prefectureCode, typeと排他。
offset int データの取得開始位置。oldName指定時無効です。省略可
Default: 1
limit int データのブロック件数。oldName指定時無効です。指定可能な値は1から100です。省略可
Default: 100

response

Name Description
ResultSet レスポンスの最下部を表す要素
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / max データの取得件数。一度に全件取得できない場合は、offsetの指定を繰り上げて取得してください。
ResultSet / offset データ開始位置のオフセット値
ResultSet / Corporation 会社を表す要素
ResultSet / Corporation / code 会社コード
ResultSet / Corporation / Name 会社の名称を表す要素
ResultSet / Corporation / OldName 会社の旧名称を表す要素
※oldNameを指定した場合のみ出現
ResultSet / Corporation / Type 交通種別を表す要素。
- train: 鉄道
- plane: 航空
ResultSet / Corporation / Type / detail 交通種別の詳細。複数存在する場合は:区切りの文字列で表現します。

example

GET /v1/xml/corporation?key=アクセスキーを入力してください&prefectureCode=1
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" max="5" offset="1" engineVersion="201612_02a">
  <Corporation code="1">
    <Name>JR</Name>
    <Type>train</Type>
  </Corporation>
  <Corporation code="30">
    <Name>札幌市交通局</Name>
    <Type>train</Type>
  </Corporation>
  <Corporation code="221">
    <Name>道南いさりび鉄道</Name>
    <Type>train</Type>
  </Corporation>
  <Corporation code="31">
    <Name>函館市企業局交通部</Name>
    <Type>train</Type>
  </Corporation>
  <Corporation code="8">
    <Name>航空会社</Name>
    <Type>plane</Type>
  </Corporation>
</ResultSet>
GET /v1/json/corporation?key=アクセスキーを入力してください&prefectureCode=1
{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "max": "5",
    "offset": "1",
    "engineVersion": "201612_02a",
    "Corporation": [
      {
        "code": "1",
        "Name": "JR",
        "Type": "train"
      },
      {
        "code": "30",
        "Name": "札幌市交通局",
        "Type": "train"
      },
      {
        "code": "221",
        "Name": "道南いさりび鉄道",
        "Type": "train"
      },
      {
        "code": "31",
        "Name": "函館市企業局交通部",
        "Type": "train"
      },
      {
        "code": "8",
        "Name": "航空会社",
        "Type": "plane"
      }
    ]
  }
}