駅すぱあと API BLOG

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

駅、路線、会社が現在も利用可能かを確認できるようになりました

f:id:ekispert_api:20200602193138p:plain

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

「駅すぱあとWebサービス」では、最新の公共交通機関の情報に対応するため、データ更新をしていますが、名称変更や廃止のため、保存していた駅や路線が利用できなくなることがあります。

そのため、この度、駅、平均路線、会社の名称を保存しているケースに対して、情報が最新であるか、名称に変更がないか、利用可能であるか、という、更新の確認ができる機能をリリースしました!

今回の機能は、チェック専用の機能となっていて、複数(※それぞれ最大10件まで)の駅、平均路線、会社の名称を一度に確認することができます。

更に、今回の機能は従量課金の対象外の機能となります。 あくまで、既に利用している情報を確認するための機能であることから、課金対象外としました。

ぜひ、駅、平均路線、会社の名称情報を保存されている場合には、更新の確認にご利用ください。

具体的には

経路情報の更新判定(/toolbox/course/update)という機能が追加されます。

詳細なリクエストパラメータやレスポンスパラメータについては、以下のWedドキュメントをご覧ください。

経路情報の更新判定(/toolbox/course/update)

例えば、定期情報として

浅草 - 東武伊勢崎線区間準急 - 業平橋

を保存していた場合、リクエストは以下のようになります。

https://api.ekispert.jp/v1/xml/toolbox/course/update?key=アクセスキーを入力してください&stationNameList=浅草:業平橋&railNameList=東武伊勢崎線区間準急

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

<ResultSet apiVersion="1.27.0.0" engineVersion="202006_03a">
  <Update>
    <Type>station</Type>
    <Point index="1">
      <Station code="22495">
        <Name>浅草</Name>
        <Type>train</Type>
        <Yomi>あさくさ</Yomi>
      </Station>
      <Status code="0" />
    </Point>
    <Point index="2">
      <Station code="22859">
        <OldName>業平橋</OldName>
        <Name>とうきょうスカイツリー</Name>
        <Type>train</Type>
        <Yomi>とうきょうすかいつりー</Yomi>
      </Station>
      <Status code="1" />
    </Point>
  </Update>
  <Update>
    <Type>rail</Type>
    <Line index="1">
      <Name>東武伊勢崎線区間準急</Name>
      <Status code="0" />
    </Line>
  </Update>
</ResultSet>

ResultSet / Update / Point / Status / code に、更新判定結果のコードが返ります。

コードが0の場合は、最新の状態であることを表し、コードが1の場合は、名称の変更があることを表します。

また、名称の変更が合った場合には、最新の名称もレスポンスに返ります。

上記の例では、「業平橋」駅のコードが1となっており、新しい駅名が「とうきょうスカイツリー」であることがわかります。

その他のコードにつきましては、以下のドキュメントをご覧ください。

経路情報の更新判定のステータスコード

おわりに

今回は、保存している情報の更新判定、利用判定をするための新しい機能のご紹介でした。 ドキュメントの方もぜひご覧ください。


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