新幹線eチケットを利用した経路探索ができるようになりました

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

この度「駅すぱあとWebサービス」では、新幹線eチケットを利用した経路探索ができるようになりました。

具体的には？

探索条件生成（/toolbox/course/condition）に新幹線eチケットの利用を設定するshinkansenETicketパラメータが追加されました。

例えば、探索条件生成において、新幹線eチケットを利用するように設定したい場合には、以下のようなリクエストになります。

https://api.ekispert.jp/v1/xml/toolbox/course/condition?key=アクセスキーを入力してください&shinkansenETicket=eTicket

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

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

<ResultSet apiVersion="x.x.x.x"engineVersion="yyyymm_xx">
    <Condition>T3221233232319:F3321122120001:A23121141:</Condition>
</ResultSet>

新幹線eチケットの利用を有効にして生成した探索条件を使い、新幹線eチケットに対応している区間が存在する経路探索をした場合には、新幹線eチケットが適用された結果が返ります。

リクエスト例は以下になります。

https://api.ekispert.jp/v1/xml/search/course/extreme?key=アクセスキーを入力してください&viaList=東京:新大阪&conditionDetail=T3221233232319:F3321122120001:A23121141:

新幹線eチケットが適用された区間の場合には、以下のような値が返ります。

<ResultSet apiVersion="x.x.x.x"engineVersion="yyyymm_xx">
    <Course searchType="departure" dataType="onTimetable">
        <Route index="1" ...>
            <Point ...>
                ...
            </Point>
            <Line ...>
                <Name>JR新幹線XXX</Name>
                <Type detail="shinkansen">train</Type>
                ...
            </Line>
            <Point ...>
                ...
            </Point>
            ...
        </Route>
        <Price kind="ChargeSummary">
            <Oneway>xxxxx</Oneway>
            <Round>xxxxx</Round>
        </Price>
        <!-- 新幹線ｅチケットが適用された区間の料金は、運賃が含まれた金額になる -->
        <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Charge" index="1" selected="false">
            <Name>指定席</Name>
            <Type>Reserved</Type>
            <Oneway remark="eチケット" fullRemark="新幹線eチケット">xxxx</Oneway>
            <RevisionStatus>latest</RevisionStatus>
            <Round remark="eチケット" fullRemark="新幹線eチケット">xxxxx</Round>
            <Rate area="Main">Regular</Rate>
        </Price>
        <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Charge" index="2" selected="true">
            <Name>自由席</Name>
            <Type>Free</Type>
            <Oneway remark="eチケット" fullRemark="新幹線eチケット">xxxx</Oneway>
            <RevisionStatus>latest</RevisionStatus>
            <Round remark="eチケット" fullRemark="新幹線eチケット">xxxxx</Round>
        </Price>
        ...
        <!-- 新幹線ｅチケットが適用された区間の運賃は0円となる -->
        <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Fare" index="1" selected="true">
            <Type>Fare</Type>
            <Oneway remark="eチケット" fullRemark="新幹線eチケット" includedInCharge="true">0</Oneway>
            <RevisionStatus>latest</RevisionStatus>
            <Round remark="eチケット" fullRemark="新幹線eチケット" includedInCharge="true">0</Round>
        </Price>
        <Price kind="FareSummary">
            <Oneway>0</Oneway>
            <Round>0</Round>
        </Price>
        <Price kind="Teiki1Summary">
            ...
        </Price>
        <Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Teiki1" index="1" selected="true">
            <Type>Teiki1</Type>
            ...
        </Price>
        ...
    </Course>
    ...
</ResultSet>