経路の再現／定期券・指定列車利用
経路シリアライズデータを利用した各種経路の操作ができる機能です。指定パラメータの組み合わせによって、機能が変わります。
| 組み合わせパターン |
|---|
serializeDataのみを指定した場合は経路の再現を行います。 |
serializeDataとassignRoute,assignDetailRoute,assignTeikiSerializeDataのいずれかを指定した場合は、serializeDataの再現経路にてassignRoute,assignDetailRoute,assignTeikiSerializeDataを定期券経路として利用します。 |
serializeDataとcouponを指定した場合はserializeDataの再現経路に回数券を利用します。 |
serializeDataとlineCode, sectionIndex, assignInstructionを指定した場合は、serializeDataの再現経路の指定区間を指定の列車に置き換えます。ただし、 assignInstructionの値にAutoPrevious, AutoNextのいずれかを指定した場合は、自動的に列車を適応します。詳しくはこちら。 |
serializeDataとsectionIndex, assignType, date, timeを指定した場合はserializeDataの再現経路の指定区間を指定の日時で再探索します。 |
GET /v1/{format}/course/edit
parameters
※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。
| Name | Type | Required | Description |
|---|---|---|---|
| format | string | ◯ | レスポンスのデータ形式の指定。必須。 指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。 |
| key | string | ◯ | アクセスキー。必須 |
| serializeData | string | ◯ | 経路シリアライズデータ。必須 |
| checkEngineVersion | string | --- | 完全な定期経路シリアライズデータ、及び経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。 指定できる値: - true: チェックする - false: チェックしない Default: true |
| assignTeikiSerializeData | string | --- | 定期経路シリアライズデータ。省略可。assignRoute, assignDetailRouteと排他。 ※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。 |
| assignRoute | string | --- | 定期経路文字列(方向なし)。駅の名称:平均路線:駅の名称...の羅列。省略可。assignDetailRouteと排他。Example: 高円寺:ＪＲ中央線快速:新宿:ＪＲ山手線外回り:池袋 ※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。 |
| assignDetailRoute | string | --- | 定期経路文字列。駅の名称:平均路線:方向:駅の名称...の羅列。省略可。assignRouteと排他。Example: 高円寺:ＪＲ中央線快速:Up:新宿:ＪＲ山手線外回り:Down:池袋 ※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。 |
| assignPassClassIndex | int | --- | 定期券利用時の運賃計算を行う際に、利用する定期経路に定期券の種類が複数ある場合は、PassStatus（kind="nikukanteiki"またはkind="bycorporation"）のindexの値を指定することで、定期券の種類を切り替えることができます。 複数指定可。同一区間のインデックスが複数指定された場合はどれか一つを適用します。 assignRoute, assignDetailRoute, assignTeikiSerializeDataのいずれか指定時のみ有効。 省略可。省略時は、デフォルトの定期券となります。 assignNikukanteikiIndexと排他。 ※ 詳しくは、二区間定期券などの特殊な定期券利用時の運賃計算をご確認ください。 |
| assignNikukanteikiIndex | int | --- | assignPassClassIndexと同様。※ 現在は、非推奨のパラメータとなります。これから開発を始める方は、assignPassClassIndexをご利用ください。 |
| coupon | string | --- | 回数券詳細名称。省略可 |
| addAssignStatus | string | --- | 定期券などの利用時に、レスポンスに割り当てステータスを付加します。assignRoute, assignDetailRoute, assignTeikiSerializeDataのいずれか指定時のみ有効。省略可。 指定できる値: - true: 割り当てステータスを付加する - false: 割り当てステータスを付加しない Default: false ※ 現時点では回数券の利用時には未対応です。 ※ 詳しくは定期券利用時の運賃計算 > note及び更新判定ステータスによる判定をご確認ください。 |
| sectionIndex | int | △ | 区間インデックス。 date、time、lineCodeもしくはassignType指定時は必須。 |
| lineCode | string | --- | 列車等を特定するコード。省略可 詳しくはこちらを参照。 |
| assignInstruction | string | --- | 定期券・指定列車利用時の再探索モード。 指定できる値: - SearchAll: 経路全体を再探索 - SearchAfter: 指定区間より後方を再探索 - SearchBefore: 指定区間より前方を再探索 - Replace: 指定区間を置き換える - AutoNext: 次に出発する最適なダイヤの組み合わせを設定する - AutoPrevious: 前に出発する最適なダイヤの組み合わせを設定する 詳しくはこちらを参照。 |
| assignType | string | △ | 定期券・指定列車利用時の日時の扱い。date、time指定時は必須。 指定できる値: - departure: 発時刻 - arrival: 着時刻 |
| date | int | --- | 探索日付。省略可。 Format: YYYYMMDD Default: 現在日付 |
| time | int | --- | 探索時刻。省略可。 Format: HHMM Default: 現在時刻 |
| resultDetail | string | --- | 結果に詳細情報を付加します。省略可。省略時は通常の結果となります。 指定できる値: - addCorporation: 路線に会社を付加 |
| addOperationLinePattern | string | --- | 結果に経路の区間に紐づく運行路線パターンを付加します。 ダイヤによる探索時のみ有効。省略可。 指定できる値: - true: 付加します - false: 付加しません Default: false |
| addChange | string | --- | 結果に次の路線への乗り換えに便利な乗車位置情報を付加します。ダイヤによる探索時のみ有効。省略可。 指定できる値: - true: 付加します - false: 付加しません Default: false |
| addStop | string | --- | 経路の区間に停車駅一覧を付加する。ダイヤによる探索時のみ有効。省略可。 指定できる値: - true: 付加します - false: 付加しません Default: false |
| interruptTransferStationCodeList | string | --- | 乗換しない駅リスト。乗り換えたくない駅の駅コードを指定します。複数指定可。最大30件。省略可。省略時は制限のない通常の探索となります。 |
| 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.27.0.0" engineVersion="201806_02a">
<Course dataType="onTimetable">
<Route timeOther="0" timeOnBoard="7" exhaustCO2="127" index="1" exhaustCO2atPassengerCar="974" distance="58" timeWalk="0" transferCount="0">
<Point index="1">
<Station code="22671">
<Name>高円寺</Name>
<Type>train</Type>
<Yomi>こうえんじ</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
<GeoPoint longi="139.39.10.89" lati="35.42.7.59" longi_d="139.653027" gcs="tokyo" lati_d="35.70211"/>
</Point>
<Line stopStationCount="1" teiki3Index="1" teiki6Index="1" timeOnBoard="7" track="railway" exhaustCO2="127" fareIndex="1" index="1" exhaustCO2atPassengerCar="974" distance="58" teiki1Index="1">
<Name>ＪＲ中央線快速・東京行</Name>
<Type>train</Type>
<ArrivalState no="8">
<Type>normal</Type>
<Datetime operation="today">2018-06-05T12:55:00+09:00</Datetime>
</ArrivalState>
<Destination>東京</Destination>
<TimeReliability>onTimetable</TimeReliability>
<DepartureState no="4">
<Type>normal</Type>
<Datetime operation="today">2018-06-05T12:48:00+09:00</Datetime>
</DepartureState>
<LineSymbol code="8">
<Name>JC</Name>
</LineSymbol>
<Color>250060002</Color>
</Line>
<Point index="2">
<Station code="22741">
<Name>新宿</Name>
<Type>train</Type>
<Yomi>しんじゅく</Yomi>
</Station>
<Prefecture code="13">
<Name>東京都</Name>
</Prefecture>
<GeoPoint longi="139.42.11.0" lati="35.41.15.0" longi_d="139.703056" gcs="tokyo" lati_d="35.6875"/>
</Point>
</Route>
<Price kind="FareSummary">
<Oneway>160</Oneway>
<Round>320</Round>
</Price>
<Price fareRevisionStatus="none" toLineIndex="1" fromLineIndex="1" kind="Fare" index="1" selected="true">
<Type>Fare</Type>
<Oneway>160</Oneway>
<RevisionStatus>latest</RevisionStatus>
<Round>320</Round>
</Price>
:
<SerializeData>VkV4QaECp4jIAsMCpgEz7noDpgEz7nkEkcIBQwAAAAKmATPueQPJAQECAQMBBAEHAQgBCgIPQv9_EKX_9wWUwQKlWI_BAqVY1cECpVkswQKlWQMGkcMBAQIBA8cBpVXqAhIDFAUDBkUxMTM4VAcDCAIHkcUBpgEz7n0DpQMABKUDBwUACAAIkcQEAQUBB6RtCAEJkcEDAQ|RxQGSAAECkcMBAAIAAwADkcMBAAIAAwAEkQAFkQA*--T3221233232319:F332112212000:A23121141:--dcfa423d1113de174649d873e2a7a4167465d1c4--0--0--0--182</SerializeData>
</Course>
</ResultSet>
GET /v1/json/course/edit?key=アクセスキーを入力してください&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAQAAAAAACAAB_38C__cDAAAAAAAAAAEAj1gAANVYAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--c003197761417cfffa1afc00cbbb2594d43f3041
{
"ResultSet":{
"apiVersion":"1.27.0.0",
"engineVersion":"201806_02a",
"Course":{
"dataType":"onTimetable",
"SerializeData":"VkV4QaECp4jIAsMCpgEz7noDpgEz7nkEkcIBQwAAAAKmATPueQPJAQECAQMBBAEHAQgBCgIPQv9_EKX_9wWUwQKlWI_BAqVY1cECpVkswQKlWQMGkcMBAQIBA8cBpVXqAhIDFAUDBkUxMTM4VAcDCAIHkcUBpgEz7n0DpQMABKUDBwUACAAIkcQEAQUBB6RtCAEJkcEDAQ|RxQGSAAECkcMBAAIAAwADkcMBAAIAAwAEkQAFkQA*--T3221233232319:F332112212000:A23121141:--dcfa423d1113de174649d873e2a7a4167465d1c4--0--0--0--182",
"Price":{
{
"kind":"FareSummary",
"Oneway":"160",
"Round":"320"
},
{
"fareRevisionStatus":"none",
"toLineIndex":"1",
"fromLineIndex":"1",
"kind":"Fare",
"index":"1",
"selected":"true",
"Type":"Fare",
"Oneway":"160",
"RevisionStatus":"latest",
"Round":"320"
},
{
:
}
],
"Route":{
"timeOther":"0",
"timeOnBoard":"7",
"exhaustCO2":"127",
"exhaustCO2atPassengerCar":"974",
"distance":"58",
"timeWalk":"0",
"transferCount":"0",
"Line":{
"stopStationCount":"1",
"teiki3Index":"1",
"teiki6Index":"1",
"timeOnBoard":"7",
"track":"railway",
"exhaustCO2":"127",
"fareIndex":"1",
"exhaustCO2atPassengerCar":"974",
"distance":"58",
"teiki1Index":"1",
"Name":"ＪＲ中央線快速・東京行",
"Type":"train",
"ArrivalState":{
"no":"8",
"Type":"normal",
"Datetime":{
"text":"2018-06-05T12:55:00+09:00",
"operation":"today"
}
},
"Destination":"東京",
"TimeReliability":"onTimetable",
"DepartureState":{
"no":"4",
"Type":"normal",
"Datetime":{
"text":"2018-06-05T12:48:00+09:00",
"operation":"today"
}
},
"LineSymbol":{
"code":"8",
"Name":"JC"
},
"Color":"250060002"
},
"Point":{
{
"Station":{
"code":"22671",
"Name":"高円寺",
"Type":"train",
"Yomi":"こうえんじ"
},
"Prefecture":{
"code":"13",
"Name":"東京都"
},
"GeoPoint":{
"longi":"139.39.10.89",
"lati":"35.42.7.59",
"longi_d":"139.653027",
"gcs":"tokyo",
"lati_d":"35.70211"
}
},
{
"Station":{
"code":"22741",
"Name":"新宿",
"Type":"train",
"Yomi":"しんじゅく"
},
"Prefecture":{
"code":"13",
"Name":"東京都"
},
"GeoPoint":{
"longi":"139.42.11.0",
"lati":"35.41.15.0",
"longi_d":"139.703056",
"gcs":"tokyo",
"lati_d":"35.6875"
}
}
]
}
}
}
}
