再現もしくは定期・列車割り当て

経路シリアライズデータを利用した各種経路の操作ができる機能です。指定パラメータの組み合わせによって、機能が変わります。

  • serializeDataのみを指定した場合は経路の再現を行います。
  • serializeDataとassignRouteを指定した場合はassignRouteを定期券経路としてserializeDataの再現経路に割り当てます。
  • serializeDataとcoupon指定した場合はserializeDataの再現経路に回数券を割り当てます。
  • serializeData, lineCode, sectionIndex, assignInstructionを指定した場合は、serializeDataの再現経路の指定区間を指定の列車に置き換えます。
  • serializeData, sectionIndex, assignType, date, timeを指定した場合はserializeDataの再現経路の指定区間を指定の日時で再探索します。
GET /v1/{format}/course/edit

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須。
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキー。必須
serializeData string 経路シリアライズデータ。必須
checkEngineVersion string 完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:
- true: チェックする
- false: チェックしない
Default: true
assignRoute string 定期割り当て用経路文字列。駅の名称:平均路線:駅の名称...の羅列。省略可。assignDetailRouteと排他。
Example: 高円寺:JR中央線快速:新宿:JR山手線外回り:池袋
assignDetailRoute string 定期割り当て用詳細経路文字列。駅の名称:平均路線:方向:駅の名称...の羅列。省略可。assignRouteと排他。
Example: 高円寺:JR中央線快速:Up:新宿:JR山手線外回り:Down:池袋
assignNikukanteikiIndex int 定期割り当て用経路が二区間定期の場合、その状態を表すPassStatusIndexを指定します。複数指定可。複数指定時に同区間のインデックスが指定された場合はどれか一つを適用します。省略可。省略時は定期割り当て経路は通常の定期となります。
coupon string 割り当て回数券詳細名称。省略可
sectionIndex int 区間インデックス。lineCodeもしくはassignType指定時は必須。
lineCode string 列車等を特定するコード。省略可
詳しくはこちらを参照。
assignInstruction string 割り当て時の再探索モード。
指定できる値:
- SearchAll: 経路全体を再探索
- SearchAfter: 指定区間より後方を再探索
- SearchBefore: 指定区間より前方を再探索
- Replace: 指定区間を置き換える
- AutoNext: 次に出発する最適なダイヤの組み合わせを割り当てる
- AutoPrevious: 前に出発する最適なダイヤの組み合わせを割り当てる
詳しくはこちらを参照。
assignType string 割り当て日時の扱い。省略可。
指定できる値:
- departure: 発時刻
- arrival: 着時刻
date int 探索日付。省略可。
Format: YYYYMMDD
Default: 現在日付
time int 探索時刻。省略可。
Format: HHMM
Default: 現在時刻
resultDetail string 結果に詳細情報を付加します。省略可。省略時は通常の結果となります。
指定できる値:
- addCorporation: 路線に会社を付加
addOperationLinePattern string 結果に経路の区間に紐づく運行路線パターンを付加します。
ダイヤによる探索時のみ有効。省略可。
指定できる値:
- true: 付加します
- false: 付加しません
Default: false
gcs string リクエストやレスポンスに座標が含まれる場合、座標の測地系を指定することができます。また、リクエストパラメータの座標情報はgcsパラメータとは別の測地系を個別に指定可能です。省略可。
指定できる値:
- tokyo: 日本測地系
- wgs84: 世界測地系
Default: tokyo

lineCode

lineCodeは 区間 を走る列車等を特定するための値です。

この値には、平均路線情報経路シリアライズデータと 区間インデックスを指定した際の結果に含まれるResultSet / Line / codeを利用します。

鉄道駅時刻表の結果に含まれるResultSet / TimeTable / HourTable / MinuteTable / Stop / lineCodeは利用できません。

assignInstruction

AutoNextやAutoPreviousは自動的に列車を割り当てるため、lineCodeパラメータ及びsectionIndexパラメータを指定しても結果に反映されません。assignInstructionパラメータにAutoNextやAutoPreviousを指定する場合は、serializeDataパラメータとassignInstructionパラメータの二つのみを指定してください。

response

経路探索と同等

example

GET /v1/xml/course/edit?key=アクセスキーを入力してください&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Course dataType="onTimetable">
    <Route index="1" timeOnBoard="7" timeWalk="0" timeOther="0" transferCount="0" distance="58" exhaustCO2="110" exhaustCO2atPassengerCar="974">
      <Point index="1">
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <GeoPoint gcs="tokyo" lati_d="35.702110" longi_d="139.653027" lati="35.42.7.59" longi="139.39.10.89"/>
        <Station code="22671">
          <Name>高円寺</Name>
          <Yomi>こうえんじ</Yomi>
          <Type>train</Type>
        </Station>
      </Point>
      <Line index="1" fareIndex="1" teiki1Index="1" teiki3Index="1" teiki6Index="1" timeOnBoard="7" distance="58" stopStationCount="1" exhaustCO2="110" exhaustCO2atPassengerCar="974">
        <Name>JR中央線快速・東京行</Name>
        <Type>train</Type>
        <Color>250060002</Color>
        <DepartureState no="4">
          <Type>normal</Type>
          <Datetime operation="today">2014-03-24T15:41:00+09:00</Datetime>
        </DepartureState>
        <ArrivalState no="8">
          <Type>normal</Type>
          <Datetime operation="today">2014-03-24T15:48:00+09:00</Datetime>
        </ArrivalState>
        <TimeReliability>onTimetable</TimeReliability>
        <Destination>東京</Destination>
      </Line>
      <Point index="2">
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <GeoPoint gcs="tokyo" lati_d="35.6875" longi_d="139.703055" lati="35.41.15.0" longi="139.42.11.0"/>
        <Station code="22741">
          <Name>新宿</Name>
          <Yomi>しんじゅく</Yomi>
          <Type>train</Type>
        </Station>
      </Point>
    </Route>
    <Price kind="FareSummary">
      <Oneway>150</Oneway>
      <Round>300</Round>
    </Price>
    <Price kind="Fare" index="1" fromLineIndex="1" toLineIndex="1" fareRevisionStatus="none" selected="true">
      <Oneway>150</Oneway>
      <Round>300</Round>
      <Type>Fare</Type>
    </Price>
    <Price kind="Teiki1Summary">
      <Oneway>4730</Oneway>
    </Price>
    <Price kind="Teiki1" index="1" fromLineIndex="1" toLineIndex="1" fareRevisionStatus="none" selected="true">
      <Oneway>4730</Oneway>
      <Type>Teiki1</Type>
    </Price>
    <Price kind="Teiki3Summary">
      <Oneway>13470</Oneway>
    </Price>
    <Price>
    :
    </Price>
    <SerializeData>SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041</SerializeData>
  </Course>
</ResultSet>
GET /v1/json/course/edit?key=アクセスキーを入力してください&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Course": {
      "dataType": "onTimetable",
      "Route": {
        "timeOnBoard": "7",
        "timeWalk": "0",
        "timeOther": "0",
        "transferCount": "0",
        "distance": "58",
        "exhaustCO2": "110",
        "exhaustCO2atPassengerCar": "974",
        "Point": [
          {
            "Prefecture": {
              "code": "13",
              "Name": "東京都"
            },
            "GeoPoint": {
              "gcs": "tokyo",
              "lati_d": "35.702110",
              "longi_d": "139.653027",
              "lati": "35.42.7.59",
              "longi": "139.39.10.89"
            },
            "Station": {
              "code": "22671",
              "Name": "高円寺",
              "Yomi": "こうえんじ",
              "Type": "train"
            }
          },
          {
            "Prefecture": {
              "code": "13",
              "Name": "東京都"
            },
            "GeoPoint": {
              "gcs": "tokyo",
              "lati_d": "35.6875",
              "longi_d": "139.703055",
              "lati": "35.41.15.0",
              "longi": "139.42.11.0"
            },
            "Station": {
              "code": "22741",
              "Name": "新宿",
              "Yomi": "しんじゅく",
              "Type": "train"
            }
          }
        ],
        "Line": {
          "fareIndex": "1",
          "teiki1Index": "1",
          "teiki3Index": "1",
          "teiki6Index": "1",
          "timeOnBoard": "7",
          "distance": "58",
          "stopStationCount": "1",
          "exhaustCO2": "110",
          "exhaustCO2atPassengerCar": "974",
          "Name": "JR中央線快速・東京行",
          "Type": "train",
          "Color": "250060002",
          "DepartureState": {
            "no": "4",
            "Type": "normal",
            "Datetime": {
              "text": "2014-03-24T15:41:00+09:00",
              "operation": "today"
            }
          },
          "ArrivalState": {
            "no": "8",
            "Type": "normal",
            "Datetime": {
              "text": "2014-03-24T15:48:00+09:00",
              "operation": "today"
            }
          },
          "TimeReliability": "onTimetable",
          "Destination": "東京"
        }
      },
      "Price": [
        {
          "kind": "FareSummary",
          "Oneway": "150",
          "Round": "300"
        },
        {
          "kind": "Fare",
          "index": "1",
          "fromLineIndex": "1",
          "toLineIndex": "1",
          "fareRevisionStatus": "none",
          "selected": "true",
          "Oneway": "150",
          "Round": "300",
          "Type": "Fare"
        },
        {
          "kind": "Teiki1Summary",
          "Oneway": "4730"
        },
        {
          "kind": "Teiki1",
          "index": "1",
          "fromLineIndex": "1",
          "toLineIndex": "1",
          "fareRevisionStatus": "none",
          "selected": "true",
          "Oneway": "4730",
          "Type": "Teiki1"
        },
        {
          "kind": "Teiki3Summary",
          "Oneway": "13470"
        },
        {
          :
        }
      ],
      "SerializeData": "SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041"
    }
  }
}