経路探索に回数券を利用する

経路探索で回数券を利用します。

手順

1. 経路を探索する

経路探索を行います。リクエスト例は経路探索 /search/course/extreme のダイヤによる探索を利用していますが、ダイヤによる探索、平均待ち時間による探索は問わないので、経路簡易探索、平均待ち時間探索でも可能です。

※リクエスト例では日本語で記述しておりますが、リクエストパラメータに日本語が含まれる場合には、日本語の部分をUTF8でURLエンコード(パーセントエンコード)してください。

GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=東京:熱海

<ResultSet apiVersion="1.27.0.0" engineVersion="202210_01a">
  <Course searchType="departure" dataType="onTimetable">
  :
  <SerializeData>経路シリアライズデータ</SerializeData>
  :

2. 経路で利用可能な回数券の詳細を取得する

1で取得できる経路シリアライズデータを利用します。

GET /v1/xml/coupon/detail?key=アクセスキーを入力してください&serializeData=1で取得できる経路シリアライズデータを入れてください

<ResultSet apiVersion="1.27.0.0" engineVersion="202210_01a">
  <Coupon index="1">
    <Name>新幹線回数券(自由席):東京都区内:熱海</Name>
    <Detail>
      <Direction>Both</Direction>
      <ValidPeriod>3</ValidPeriod>
      <Price>
        <Amount>20340</Amount>
      </Price>
      <Count>6</Count>
    </Detail>
  </Coupon>
  :

3. 再度経路探索を行い回数券を利用する

2で取得できる回数券詳細名称 ResultSet/Coupon/Name を利用します。 bringAssignmentErrorパラメータを利用すると、回数券が利用されていない場合にエラーを出力します。

GET /v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=東京:熱海&coupon=新幹線回数券(自由席):東京都区内:熱海&bringAssignmentError=true

<ResultSet apiVersion="1.27.0.0" engineVersion="202210_01a">
  <Course searchType="departure" dataType="onTimetable">
  :
  <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Charge" index="1" selected="true">
    <Name>回数券利用</Name>
    <Type>WithCoupon</Type>
    <Oneway>0</Oneway>
    <RevisionStatus>latest</RevisionStatus>
    <Round>0</Round>
  </Price>
  :

経路探索に回数券を利用する

関連URL

手順

1. 経路を探索する

2. 経路で利用可能な回数券の詳細を取得する

3. 再度経路探索を行い回数券を利用する