public static final class EkispertWebKey.CourseEdit extends Object
経路シリアライズデータを利用した各種経路の操作ができる機能です。 指定パラメータの組み合わせによって、機能が変わります。 ・serializeDataのみを指定した場合は経路の再現を行います。 ・serializeDataとassignRouteを指定した場合はassignRouteを定期券経路としてserializeDataの再現経路に割り当てます。 ・serializeDataとcoupon指定した場合はserializeDataの再現経路に回数券を割り当てます。 ・serializeData, lineCode, sectionIndex, assignInstructionを指定した場合は、serializeDataの再現経路の指定区間を指定の列車に置き換えます。 ・serializeData, sectionIndex, assignType, date, timeを指定した場合はserializeDataの再現経路の指定区間を指定の日時で再探索します。 ※ リクエストやレスポンスに座標が含まれる場合、座標の測地系をgcsパラメータで指定することができます。 ※ リクエストパラメータに日本語が含まれる場合には、UTF8でURLエンコードしてください。 ※ 「複数指定可」となっているパラメータに値を複数指定する場合は、コロン(:)区切りで記述してください。
http://api.ekispert.jp/doc/api/course/edit.html
修飾子とタイプ | フィールドと説明 |
---|---|
static String |
ASSIGNDETAILROUTE
定期割り当て用詳細経路文字列(assignRoute, couponと排他, 駅名:路線名:方向:駅名...の羅列, 省略可).
|
static String |
ASSIGNINSTRUCTION
割り当て時の再探索モード(経路全体を再探索:SearchAll, 指定区間より後方を再探索:SearchAfter, 指定区間より前方を再探索:SearchBefore, 指定区間を置き換える:Replace).
|
static String |
ASSIGNNIKUKANTEIKIINDEX
定期割り当て用経路が二区間定期の場合、その状態を表すPassStatusのindexを指定(複数指定可(複数指定時に同区間のインデックスが指定された場合はどれか一つを適用します),
省略時は定期割り当て経路は通常の定期となります).
|
static String |
ASSIGNROUTE
定期割り当て用経路文字列(assignDetailRoute, couponと排他, 駅名:路線名:駅名...の羅列, 省略可).
|
static String |
ASSIGNTYPE
割り当て日時の扱い(発時刻:departure 着時刻:arrival, 省略可).
|
static String |
COUPON
割り当て回数券詳細名称(assignRoute, assignDetailRouteと排他, 省略可).
|
static String |
DATE
割り当て日付(YYYYMMDD)(省略時は現在日付となります).
|
static String |
LINECODE
列車等を特定するコード(省略可).
|
static String |
RESULTDETAIL
結果に詳細情報を付加(路線に会社を付加:addCorporation, 省略時は通常の結果となります).
|
static String |
SECTIONINDEX
区間インデックス(lineCodeもしくはassignType指定時は必須).
|
static String |
SERIALIZEDATA
経路シリアライズデータ.
|
static String |
TIME
割り当て時刻(HHMM)(省略時は現在時刻となります).
|
コンストラクタと説明 |
---|
CourseEdit() |
public static final String SERIALIZEDATA
■ 経路シリアライズデータ
経路探索の結果に含まれる経路復元情報としての経路シリアライズデータは、 ごく短時間の利用に限り有効なものです。 データベースへの保存等には適していません。 経路探索後、特定の区間に対して定期を割り当てたり、 停車駅の一覧を取得する場合などにご利用いただけます。 経路シリアライズデータはエンジンのバージョン(engineVersion)に依存してるため、 バージョンを超えて経路を再現する場合は、 経路シリアライズデータを利用せず、 経路の駅コードと路線名を保存し、その情報を利用して駅間の路線を固定して再探索してください。 また、時刻を含む経路は、時刻の元となるデータがバージョンに依存するため、 エンジンのバージョンを越えて再現することはできません。
public static final String ASSIGNROUTE
■ assignRouteの指定について
assignRouteの路線名は、平均待ち時間による探索で得られた結果に含まれるLineの名称を指定します。 同じ名称は、路線情報にfromとtoを指定した場合にも得られます。 上記手段以外(出発時刻探索など)により取得した路線名を指定すると、定期の割り当てが正常に行われない可能性があります。
public static final String ASSIGNDETAILROUTE
public static final String ASSIGNNIKUKANTEIKIINDEX
public static final String COUPON
public static final String SECTIONINDEX
public static final String LINECODE
■ 列車等を特定するコード
列車等を特定するためのコードは二種類あります。 一つは、路線情報(rail)に経路シリアライズデータと区間インデックスを指定して得られる結果に含まれるLine要素のcode属性で、 この値は、経路探索結果の操作(course/edit)や列車等の停車駅情報の取得(course/trainStation)に利用されます。 もう一つは、駅時刻表(station/timetable)や区間時刻表(course/timetable)の結果に含まれるStop要素のlineCode属性で、 この値は、列車情報の取得(station/timetable/train, course/timetable/train)に利用されます。 それぞれは別の値なので、路線情報で取得したコードを列車情報の取得に利用したり、 時刻表で取得したコードを経路探索結果の操作や列車等の停車駅の取得に利用することはできません。 どちらも短期的な利用を前提としているため、データベースへの保存等には適していません。■ lineCodeの取得と指定について
lineCodeは区間を走る列車等を特定するための値です。 この値には、路線情報で経路シリアライズデータと区間インデックスを指定した際の結果に含まれる Line要素のcode属性を利用します。 駅時刻表の結果に含まれるStop要素のlineCode属性は利用できません。
public static final String ASSIGNINSTRUCTION
public static final String ASSIGNTYPE
Copyright © 2024 Sumitomo Life Information Systems Co., Ltd. All Rights Reserved.