オフピーク定期券の定期代を調べる
オフピーク定期区間が存在する経路の場合に、オフピーク定期券として定期代を取得する方法を記載します。
関連URL
手順
1. 経路探索に用いる「オフピーク定期券として計算する」条件を生成する
オフピーク定期券の金額は、デフォルトでは経路探索結果に返りません。
オフピーク定期券の金額を取得するには、探索条件生成のoffpeakTeikiパラメータにて、「オフピーク定期券として計算する」条件を生成します。
GET /v1/xml/toolbox/course/condition?key=アクセスキーを入力してください&offpeakTeiki=true
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="202303_01a">
<Condition>T32212332323191:F33211221200002:A23121141:</Condition>
</ResultSet>
2. 経路探索してオフピーク定期券の金額を取得する
経路探索 /search/course/extreme する際に、1で生成した「オフピーク定期券として計算する」詳細探索条件を指定すると、探索結果に定期区間が「オフピーク定期区間かの状態判定」（ResultSet / Course / Price / offpeakTeiki）が追加され、オフピーク定期区間の場合は定期代がオフピーク定期券の金額となり、オフピーク定期区間でない場合は定期代は通常の金額となります。
なお、「オフピーク定期券として計算しない」詳細探索条件が指定された場合は、探索結果に「オフピーク定期区間かの状態判定」は返りません。
GET search/course/extreme?key=アクセスキーを入力してください&viaList=22630:22528:21987&date=20230318&searchType=plain&conditionDetail=T32212332323191:F33211221200002:A23121141:
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="202303_01a">
<!-- 1経路目 -->
<Course searchType="plain" dataType="plain">
<Route index="1" timeOther="20" timeOnBoard="38" distance="341" timeWalk="0" transferCount="1" ...>
<Point index="1">
<Station code="22630">
<Name>北千住</Name>
:
</Point>
<Line index="1" teiki1Index="1" teiki3Index="1" teiki6Index="1" timeOnBoard="11" ...>
<Name>ＪＲ常磐線快速</Name>
:
</Line>
<Point index="2">
<Station code="22528">
<Name>上野</Name>
:
</Point>
<Line index="2" teiki1Index="1" teiki3Index="1" teiki6Index="1" ...>
<Name>ＪＲ東北本線(上野－宇都宮)</Name>
:
</Line>
<Point index="3">
<Station code="21987">
<Name>大宮(埼玉県)</Name>
:
</Point>
</Route>
<SerializeData>...</SerializeData>
<Teiki>...</Teiki>
<Price ...>...</Price>
<Price kind="Teiki1Summary">
<Oneway>13030</Oneway>
</Price>
<!-- 定期区間1はオフピーク定期区間であり、１ヶ月定期代(13030円)はオフピーク定期券の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="true" toLineIndex="2" fromLineIndex="1" passClassIndex="1" kind="Teiki1" index="1" selected="true" nikukanteikiIndex="1">
<Type>Teiki1</Type>
<Oneway>13030</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<Price kind="Teiki3Summary">
<Oneway>37120</Oneway>
</Price>
<!-- 定期区間1はオフピーク定期区間であり、３ヶ月定期代(37120円)はオフピーク定期券の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="true" toLineIndex="2" fromLineIndex="1" passClassIndex="1" kind="Teiki3" index="1" selected="true" nikukanteikiIndex="1">
<Type>Teiki3</Type>
<Oneway>37120</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<Price kind="Teiki6Summary">
<Oneway>62600</Oneway>
</Price>
<!-- 定期区間1はオフピーク定期区間であり、６ヶ月定期代(62600円)はオフピーク定期券の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="true" toLineIndex="2" fromLineIndex="1" passClassIndex="1" kind="Teiki6" index="1" selected="true" nikukanteikiIndex="1">
<Type>Teiki6</Type>
<Oneway>62600</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<PassStatus teiki3Index="1" toLineIndex="2" teiki6Index="1" fromLineIndex="1" kind="nikukanteiki" index="1" selected="true" teiki1Index="1">
<Name>区間外定期</Name>
<Type>Kukangai</Type>
<Comment>上野、鶯谷では改札での入出場不可</Comment>
</PassStatus>
</Course>
<!-- 2経路目 -->
<Course searchType="plain" dataType="plain">
<Route index="2" timeOther="22" timeOnBoard="36" distance="320" timeWalk="0" transferCount="1" ...>
<Point index="1">
<Station code="22630">
<Name>北千住</Name>
:
</Point>
<Line index="1" teiki1Index="1" teiki3Index="1" teiki6Index="1" ...>
<Name>東京メトロ日比谷線</Name>
:
</Line>
<Point index="2">
<Station code="22528">
<Name>上野</Name>
:
</Point>
<Line index="2" teiki1Index="2" teiki3Index="2" teiki6Index="2" ...>
<Name>ＪＲ東北本線(上野－宇都宮)</Name>
:
</Line>
<Point index="3">
<Station code="21987">
<Name>大宮(埼玉県)</Name>
:
</Point>
</Route>
<SerializeData>...</SerializeData>
<Teiki>...</Teiki>
<Price ...>...</Price>
<Price kind="Teiki1Summary">
<Oneway>20150</Oneway>
</Price>
<!-- 定期区間1はオフピーク定期区間ではなく、１ヶ月定期代(7120円)は通常の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="false" toLineIndex="1" fromLineIndex="1" passClassIndex="1" kind="Teiki1" index="1" selected="true">
<Type>Teiki1</Type>
<Oneway>7120</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<!-- 定期区間2はオフピーク定期区間であり、１ヶ月定期代(13030円)はオフピーク定期券の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="true" toLineIndex="2" fromLineIndex="2" kind="Teiki1" index="2" selected="true">
<Type>Teiki1</Type>
<Oneway>13030</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<Price kind="Teiki3Summary">
<Oneway>57420</Oneway>
</Price>
<!-- 定期区間1のはオフピーク定期区間ではなく、３ヶ月定期代(20300円)は通常の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="false" toLineIndex="1" fromLineIndex="1" passClassIndex="1" kind="Teiki3" index="1" selected="true">
<Type>Teiki3</Type>
<Oneway>20300</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<!-- 定期区間2はオフピーク定期区間であり、３ヶ月定期代(37120円)はオフピーク定期券の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="true" toLineIndex="2" fromLineIndex="2" kind="Teiki3" index="2" selected="true">
<Type>Teiki3</Type>
<Oneway>37120</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<Price kind="Teiki6Summary">
<Oneway>101050</Oneway>
</Price>
<!-- 定期区間1のはオフピーク定期区間ではなく、６ヶ月定期代(38450円)は通常の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="false" toLineIndex="1" fromLineIndex="1" passClassIndex="1" kind="Teiki6" index="1" selected="true">
<Type>Teiki6</Type>
<Oneway>38450</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<!-- 定期区間2はオフピーク定期区間であり、６ヶ月定期代(62600円)はオフピーク定期券の金額になっている -->
<Price fareRevisionStatus="none" offpeakTeiki="true" toLineIndex="2" fromLineIndex="2" kind="Teiki6" index="2" selected="true">
<Type>Teiki6</Type>
<Oneway>62600</Oneway>
<RevisionStatus>latest</RevisionStatus>
</Price>
<PassStatus teiki3Index="1" toLineIndex="1" teiki6Index="1" fromLineIndex="1" kind="bycorporation" index="1" selected="true" teiki1Index="1">
<Name>一般定期</Name>
<Type>Normal</Type>
<Comment />
</PassStatus>
<PassStatus teiki3Index="1" toLineIndex="1" teiki6Index="1" fromLineIndex="1" kind="bycorporation" index="2" selected="false" teiki1Index="1">
<Name>全線定期</Name>
<Type>Zensen</Type>
<Comment />
</PassStatus>
</Course>
:
</ResultSet>
