駅すぱあと API BLOG

駅すぱあと APIの開発チームが作るブログです。

鉄道運行情報に運行情報が発生している都道府県が返るようになりました

f:id:ekispert_api:20201008102202j:plain

こんにちは、駅すぱあとWebサービス開発チームの山崎です。

この度「駅すぱあとWebサービス」では、鉄道運行情報(レスキューナウ)(/operationLine/service/rescuenow/information)で、運行情報が発生している都道府県をレスポンスに返すようになりました。

具体的には?

鉄道運行情報(レスキューナウ)のレスポンスに、都道府県を表す「ResultSet / Information / Prefecture」要素が返ります。

例えば、以下のように複数の都道府県にまたがる形で運行情報が発生していたとします。

f:id:ekispert_api:20201005211746p:plain

運行情報を取得する場合には、以下のリクエストになります。

https://api.ekispert.jp/v1/xml/operationLine/service/rescuenow/information?key=アクセスキーを入力してください

※ レスポンスのフォーマットはJSON形式も選択可能です。

レスポンスは以下のようになります。

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="">
  <Information provider="レスキューナウ" status="運転状況">
    <!-- ↓↓↓都道府県を表す要素↓↓↓ -->
    <Prefecture code="9">
      <Name>栃木県</Name>
    </Prefecture>
    <Prefecture code="10">
      <Name>群馬県</Name>
    </Prefecture>
    <Prefecture code="11">
      <Name>埼玉県</Name>
    </Prefecture>
    <!-- ↑↑↑都道府県を表す要素↑↑↑ -->
    <Line corporationIndex="1" code="274">
      <Name>東武日光線</Name>
    </Line>
    <Section>
      <Point>
        <Prefecture code="11">
          <Name>埼玉県</Name>
        </Prefecture>
        <Station code="22144">
          <Name>南栗橋</Name>
          <Yomi>みなみくりはし</Yomi>
          <Type>train</Type>
        </Station>
      </Point>
      <Point>
        <Prefecture code="9">
          <Name>栃木県</Name>
        </Prefecture>
        <Station code="21800">
          <Name>栃木</Name>
          <Yomi>とちぎ</Yomi>
          <Type>train</Type>
        </Station>
      </Point>
    </Section>
    <Section>
      <Point>
        <Prefecture code="9">
          <Name>栃木県</Name>
        </Prefecture>
        <Station code="21779">
          <Name>新鹿沼</Name>
          <Yomi>しんかぬま</Yomi>
          <Type>train</Type>
        </Station>
      </Point>
      <Point>
        <Prefecture code="9">
          <Name>栃木県</Name>
        </Prefecture>
        <Station code="21774">
          <Name>下今市</Name>
          <Yomi>しもいまいち</Yomi>
          <Type>train</Type>
        </Station>
      </Point>
    </Section>
    <Comment status="long">台風19号災害の影響で、終日、南栗橋〜栃木駅間、新鹿沼〜
下今市駅間の運転を見合わせています。</Comment>
    :
  </Information>
  <Corporation index="1" code="11">
    <Name>東武鉄道</Name>
  </Corporation>
</ResultSet>

このように、運行情報が発生している都道府県の情報が返ります。

注意点

注意点は以下になります。

1. 影響区間の情報がない場合は路線が通る都道府県が返ります
2. 都道府県の絞り込みは運行情報の影響のある都道府県への絞り込みになります

・注意点1について

運行情報に影響区間の情報が存在しない場合は、その路線が通る全ての都道府県が返ります。 そのため、運行情報に都道府県が返らない、ということはありません。

・注意点2について

都道府県コードによる都道府県の絞り込みを行うprefectureCodeというパラメータがあります。 このパラメータは、路線が通る都道府県に対する絞り込みではなく、運行情報が発生している都道府県に対しての絞り込みとなります。

おわりに

今回のリリースにより、全国の運行情報を取得した後に、アプリケーション側で都道府県ごとに振り分けられるようになり、都道府県ごとに運行情報をリクエストする必要がなくなりました。 鉄道運行情報のドキュメントを以下に記載しますので、よろしければご覧ください。


駅すぱあとWebサービスを使ってみるには? 駅すぱあとWebサービス スタンダードプランは90日間無料でお試しできます。 こちらから申し込みして気軽に触ってみてください!

ekiworld.net