探索結果の運賃切り替え

経路の運賃を切り替えて再計算します。

GET /v1/{format}/course/recalculate

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須。
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキー。必須
serializeData string 経路シリアライズデータ。必須
checkEngineVersion string 完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:
- true: チェックする
- false: チェックしない
Default: true
fareIndex string 利用運賃指定。複数指定可。他の~Indexを指定した場合のみ省略可。省略時は指定なし
chargeIndex string 利用料金指定。複数指定可。他の~Indexを指定した場合のみ省略可。省略時は指定なし
vehicleIndex string 定期の車両指定。複数指定可。他の~Indexを指定した場合のみ省略可。省略時は指定なし
nikukanteikiIndex string 二区間定期の指定。複数指定可。他の~Indexを指定した場合のみ省略可。省略時は指定なし。
二区間定期を利用した金額を得たい場合は、 探索条件に「二区間定期を利用する」を設定した経路探索経路シリアライズデータを指定する必要があります。探索条件の設定は探索条件生成で行うことができます。
addRouteData bool 結果にRouteの情報を含むかどうかを指定。省略可。
指定できる値:
- true: 含む
- false: 含まない
Default: false
resultDetail string 結果に詳細情報を付加します。addRouteData=trueの場合のみ指定可。省略可。省略時は通常の結果となります。
指定できる値:
- addCorporation: 路線に会社を付加

状態の指定について

運賃と料金は、利用したいResultSet / Course / Priceのindexの値を指定します。 定期は、利用したいResultSet / Course / PassStatusのindexの値を指定します。1ヶ月定期に限り、同じ区間でvehicleの違いのPrice要素が存在しますが、そちらのindexは利用しません。 indexは複数指定できますが、同じ区間の金額を複数指定した場合は、指定されたもののうちどれか一つのみが選択された状態になります。

 <Price selected="false" toLineIndex="1" kind="Charge" index="1" fromLineIndex="1">
   <Name>指定席</Name>
   <Type>Reserved</Type>
 </Price>
 <Price selected="true" toLineIndex="1" kind="Charge" index="2" fromLineIndex="1">
   <Name>自由席</Name>
   <Type>Free</Type>
 </Price>
 <Price selected="false" toLineIndex="1" kind="Charge" index="3" fromLineIndex="1">
   <Name>グリーン</Name>
   <Type>Green</Type>
 </Price>

上記料金を自由席からグリーンに切り替えたい場合

GET /v1/xml/course/recalculate?chargeIndex=3&serializeData=...

下記のように指定しても、指定席かグリーンのどちらか一方に切り替わります。(同じ区間の金額は同時に選択状態になることはありません)

GET /v1/xml/course/recalculate?chargeIndex=1:3&serializeData=...

response

経路探索と同等

example

GET /v1/xml/course/recalculate?key=アクセスキーを入力してください&chargeIndex=1&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAEAAgAAAAgAAf9_Av_3AwAAAAAAAAABACxZAAB6ZQAAAAAAAAoAgQAAAFjQAAEABiRRMwG2AwAATwQAAAIAAQABAAEAAQABAAAAAAABAAEAAgAAAA**--T3221233232319:F3321122120:A23121141:--e4a50ff03c9fbdde4ca29552efa8e824c937453d
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Course dataType="onTimetable">
    <Price kind="FareSummary">
      <Oneway>8510</Oneway>
      <Round>17020</Round>
    </Price>
    <Price kind="Fare" index="1" fromLineIndex="1" toLineIndex="1" fareRevisionStatus="none" selected="true">
      <Oneway>8510</Oneway>
      <Round>17020</Round>
      <Type>Fare</Type>
    </Price>
    <Price kind="ChargeSummary">
      <Oneway>5740</Oneway>
      <Round>11480</Round>
    </Price>
    <Price kind="Charge" index="1" fromLineIndex="1" toLineIndex="1" fareRevisionStatus="none" selected="true">
      <Oneway>5740</Oneway>
      <Round>11480</Round>
      <Name>指定席</Name>
      <Type>Reserved</Type>
      <Rate area="Main">High</Rate>
    </Price>
    <Price kind="Charge" index="2" fromLineIndex="1" toLineIndex="1" fareRevisionStatus="none" selected="false">
      <Oneway>4730</Oneway>
      <Round>9460</Round>
      <Name>自由席</Name>
      <Type>Free</Type>
    </Price>
    <Price>
    :
    </Price>
  </Course>
</ResultSet>
GET /v1/json/course/recalculate?key=アクセスキーを入力してください&chargeIndex=1&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAEAAgAAAAgAAf9_Av_3AwAAAAAAAAABACxZAAB6ZQAAAAAAAAoAgQAAAFjQAAEABiRRMwG2AwAATwQAAAIAAQABAAEAAQABAAAAAAABAAEAAgAAAA**--T3221233232319:F3321122120:A23121141:--e4a50ff03c9fbdde4ca29552efa8e824c937453d
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Course": {
      "dataType": "onTimetable",
      "Price": [
        {
          "kind": "FareSummary",
          "Oneway": "8510",
          "Round": "17020"
        },
        {
          "kind": "Fare",
          "index": "1",
          "fromLineIndex": "1",
          "toLineIndex": "1",
          "fareRevisionStatus": "none",
          "selected": "true",
          "Oneway": "8510",
          "Round": "17020",
          "Type": "Fare"
        },
        {
          "kind": "ChargeSummary",
          "Oneway": "5740",
          "Round": "11480"
        },
        {
          "kind": "Charge",
          "index": "1",
          "fromLineIndex": "1",
          "toLineIndex": "1",
          "fareRevisionStatus": "none",
          "selected": "true",
          "Oneway": "5740",
          "Round": "11480",
          "Name": "指定席",
          "Type": "Reserved",
          "Rate": {
            "text": "High",
            "area": "Main"
          }
        },
        {
          "kind": "Charge",
          "index": "2",
          "fromLineIndex": "1",
          "toLineIndex": "1",
          "fareRevisionStatus": "none",
          "selected": "false",
          "Oneway": "4730",
          "Round": "9460",
          "Name": "自由席",
          "Type": "Free"
        },
        {
          :
        }
      ]
    }
  }
}