経路情報の更新判定
指定された駅、平均路線、会社に対して、
「駅すぱあと」のデータとして、名称が変更された、削除されたなどの更新状態を判定します。
また合わせて、指定日に利用可能かどうかを判定します。
なお、名称の変更がある場合は、変更後の新名称が返却されます。※路線バスは、基本的には名称の新旧に対応していません。
GET /v1/{format}/toolbox/course/update
parameters
※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。
| Name | Type | Required | Description |
|---|---|---|---|
| format | string | ◯ | レスポンスのデータ形式の指定。必須 指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。 |
| key | string | ◯ | アクセスキー 。必須 |
| stationNameList | string | --- | 駅の名称を指定する。 複数指定可。最大10件。 railNameList、corporationNameListと同時指定可。※路線バスは、名称の新旧に対応していません。 |
| railNameList | string | --- | 平均路線の名称を指定する。 複数指定可。最大10件。 stationNameList、corporationNameListと同時指定可。※路線バスは、名称の新旧に対応していません。 |
| corporationNameList | string | --- | 会社の名称を指定する。 複数指定可。最大10件。 stationNameList、railNameListと同時指定可。※路線バスは、名称の新旧に対応していません。 |
| date | string | --- | 日付。stationNameList、railNameList、corporationNameListに指定した駅または平均路線または会社が利用できる／利用できないを判定する基準となる日付。省略可。 Format: YYYYMMDD Default: 現在日付 |
response
| Name | Description |
|---|---|
| ResultSet | レスポンスの最下部を表す要素 |
| ResultSet / apiVersion | WebAPIバージョン |
| ResultSet / engineVersion | エンジンバージョン |
| ResultSet / Update | 更新情報を表す要素 |
| ResultSet / Update / Type | 情報種別を表す要素。 - station: 駅 - rail: 平均路線 - corporation: 会社 |
| ResultSet / Update / Point | 地点を表す要素 |
| ResultSet / Update / Point / index | インデックス。 ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項 |
| ResultSet / Update / Point / Status | 更新ステータスを表す要素 |
| ResultSet / Update / Point / Status / code | 経路情報の更新判定のステータスコード |
| ResultSet / Update / Point / Station | 駅を表す要素 |
| ResultSet / Update / Point / Station / code | 駅コード |
| ResultSet / Update / Point / Station / Name | 駅の名称を表す要素 |
| ResultSet / Update / Point / Station / OldName | 旧名称を表す要素。 ※ 経路情報の更新判定のステータスコードが「1: 名称変更」の場合のみ |
| ResultSet / Update / Point / Station / Type | 交通種別を表す要素 |
| ResultSet / Update / Point / Station / Type / detail | 交通種別の詳細。複数の場合は:区切り。 |
| ResultSet / Update / Point / Station / Yomi | 駅の読みがなを表す要素 |
| ResultSet / Update / Line | 区間を表す要素 |
| ResultSet / Update / Line / index | インデックス。 ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項 |
| ResultSet / Update / Line / Status | 更新ステータスを表す要素 |
| ResultSet / Update / Line / Status / code | 経路情報の更新判定のステータスコード |
| ResultSet / Update / Line / Name | 区間の名称を表す要素 |
| ResultSet / Update / Line / OldName | 旧名称を表す要素。 ※ 経路情報の更新判定のステータスコードが「1: 名称変更」の場合のみ |
| ResultSet / Update / Corporation | 会社を表す要素 |
| ResultSet / Update / Corporation / index | インデックス。 ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項 |
| ResultSet / Update / Corporation / Status | 更新ステータスを表す要素 |
| ResultSet / Update / Corporation / Status / code | 経路情報の更新判定のステータスコード |
| ResultSet / Update / Corporation / code | 会社コード |
| ResultSet / Update / Corporation / Name | 会社の名称を表す要素 |
| ResultSet / Update / Corporation / OldName | 旧名称を表す要素。 ※ 経路情報の更新判定のステータスコードが「1: 名称変更」の場合のみ |
example
GET /v1/xml/toolbox/course/update?key=アクセスキーを入力してください&date=20200401&stationNameList=高円寺:羽田空港第２ビル(東京モノレール・ＡＮＡ利用):川平:古瀬:江差&railNameList=ＪＲ中央線快速:近鉄奈良線快急:小田急小田原線急行(代々木上原－新百合ケ丘):旅客船(丸亀港～手島港)&corporationNameList=ＪＲ:東京急行電鉄:富山ライトレール:十和田観光電鉄:備讃フェリー
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="202004_02a">
<Update>
<Type>station</Type>
<Point index="1">
<Station code="22671">
<Name>高円寺</Name>
<Type>train</Type>
<Yomi>こうえんじ</Yomi>
</Station>
<Status code="0" />
</Point>
<Point index="2">
<Station code="29510">
<OldName>羽田空港第２ビル(東京モノレール・ＡＮＡ利用)</OldName>
<Name>羽田空港第２ターミナル(東京モノレール・ＡＮＡ利用)</Name>
<Type>train</Type>
<Yomi>はねだくうこうだいにたーみなる</Yomi>
</Station>
<Status code="1" />
</Point>
<Point index="3">
<Status code="2" />
</Point>
<Point index="4">
<Station code="20506">
<Name>古瀬</Name>
<Type>train</Type>
<Yomi>ふるせ</Yomi>
</Station>
<Status code="3" />
</Point>
<Point index="5">
<Status code="9" />
</Point>
</Update>
<Update>
<Type>rail</Type>
<Line index="1">
<Name>ＪＲ中央線快速</Name>
<Status code="0" />
</Line>
<Line index="2">
<OldName>近鉄奈良線快急</OldName>
<Name>近鉄奈良線快速急行</Name>
<Status code="1" />
</Line>
<Line index="3">
<Status code="2" />
</Line>
<Line index="4">
<Status code="9" />
</Line>
</Update>
<Update>
<Type>corporation</Type>
<Corporation index="1" code="1">
<Name>ＪＲ</Name>
<Status code="0" />
</Corporation>
<Corporation index="2" code="16">
<OldName>東京急行電鉄</OldName>
<Name>東急電鉄</Name>
<Status code="1" />
</Corporation>
<Corporation index="3" code="205">
<Name>富山ライトレール</Name>
<Status code="3" />
</Corporation>
<Corporation index="4">
<Status code="2" />
</Corporation>
<Corporation index="5">
<Status code="9" />
</Corporation>
</Update>
</ResultSet>
※上記はサンプルデータとなります。実際の返却値とは異なる場合があります。
GET /v1/json/toolbox/course/update?key=アクセスキーを入力してください&date=20200401&stationNameList=高円寺:羽田空港第２ビル(東京モノレール・ＡＮＡ利用):川平:古瀬:江差&railNameList=ＪＲ中央線快速:近鉄奈良線快急:小田急小田原線急行(代々木上原－新百合ケ丘):旅客船(丸亀港～手島港)&corporationNameList=ＪＲ:東京急行電鉄:富山ライトレール:十和田観光電鉄:備讃フェリー
{
"ResultSet": {
"apiVersion": "1.27.0.0",
"engineVersion": "202004_02a",
"Update": [
{
"Type": "station",
"Point": [
{
"Station": {
"code": "22671",
"Name": "高円寺",
"Type": "train",
"Yomi": "こうえんじ"
},
"Status": {
"code": "0"
}
},
{
"Station": {
"code": "29510",
"OldName": "羽田空港第２ビル(東京モノレール・ＡＮＡ利用)",
"Name": "羽田空港第２ターミナル(東京モノレール・ＡＮＡ利用)",
"Type": "train",
"Yomi": "はねだくうこうだいにたーみなる"
},
"Status": {
"code": "1"
}
},
{
"Status": {
"code": "2"
}
},
{
"Station": {
"code": "20506",
"Name": "古瀬",
"Type": "train",
"Yomi": "ふるせ"
},
"Status": {
"code": "3"
}
},
{
"Status": {
"code": "9"
}
}
]
},
{
"Type": "rail",
"Line": [
{
"Name": "ＪＲ中央線快速",
"Status": {
"code": "0"
}
},
{
"OldName": "近鉄奈良線快急",
"Name": "近鉄奈良線快速急行",
"Status": {
"code": "1"
}
},
{
"Status": {
"code": "2"
}
},
{
"Status": {
"code": "9"
}
}
]
},
{
"Type": "corporation",
"Corporation": [
{
"code": "1",
"Name": "ＪＲ",
"Status": {
"code": "0"
}
},
{
"code": "16",
"OldName": "東京急行電鉄",
"Name": "東急電鉄",
"Status": {
"code": "1"
}
},
{
"code": "205",
"Name": "富山ライトレール",
"Status": {
"code": "3"
}
},
{
"Status": {
"code": "2"
}
},
{
"Status": {
"code": "9"
}
}
]
}
]
}
}
※上記はサンプルデータとなります。実際の返却値とは異なる場合があります。
