範囲探索機能で出発駅での乗車待ち時間の設定ができるようになりました

こんにちは、駅すぱあとWebサービス開発チームの山崎です。

この度「駅すぱあとWebサービス」では、「範囲探索」機能で、出発駅での平均乗車待ち時間を所要時間に含めない設定ができるようになりました。

「範囲探索」機能について

「範囲探索」機能とは、ある駅からX分以内に辿り着ける駅を取得する機能です。また、駅は最大で5個まで指定でき、乗り換えの上限回数も設定ができます。

詳しくは、以下のドキュメントをご覧ください。 docs.ekispert.com

出発駅の平均乗車待ち時間とは

出発駅の平均乗車待ち時間とは、起点とする駅で電車の到着を待つ平均的な時間で、1日の列車の本数や間隔から設定されています。

出発駅の平均乗車待ち時間を所要時間に含める場合、出発駅に着いてから到着駅に移動するまでの実際にかかる時間の目安となり、出発駅の平均乗車待ち時間を所要時間に含めない場合、出発駅で電車に乗ってから到着駅に移動するまでの時間の目安となります。

今回のアップデートで、利用目的に合わせて、出発駅の平均乗車待ち時間の有無を選べるようになりました

具体的な変更点

「範囲探索」機能の変更点は以下のとおりです。

機能名：範囲探索（/search/multipleRange）
パラメータ名： waitAverageTime
値
- true：出発駅の平均乗車待ち時間を含む（デフォルト）
- false：出発駅の平均乗車待ち時間を含まない

このパラメータを利用し、出発駅の平均乗車待ち時間の設定をします。例として、新宿駅を起点駅とし、高円寺駅までの所要時間を比較してみます。

まずは、出発駅の平均待ち時間を含んだ状態での結果を取得します。

https://api.ekispert.jp/v1/xml/search/multipleRange?key=アクセスキー&baseList=新宿&upperMinute=15&waitAverageTime=true

※ 例のため、分かりやすく駅名称を指定していますが、駅コードの指定を推奨しています。

高円寺駅に対しての結果は以下のようになります。

<ResultSet apiVersion="1.27.0.0" engineVersion="202304_02a">
    :
    <Point>
        <Station code="22671">
            <Name>高円寺</Name>
            <Type>train</Type>
        </Station>
        <Prefecture code="13">
            <Name>東京都</Name>
        </Prefecture>
        <Cost baseIndex="1">
            <!-- 所要時間は12分 -->
            <Minute>12</Minute>
            <TransferCount>0</TransferCount>
        </Cost>
    </Point>
    :
    <Base index="1">
        <Point>
            <Station code="22741">
                <Name>新宿</Name>
                <Type>train</Type>
            </Station>
            <Prefecture code="13">
                <Name>東京都</Name>
                </Prefecture>
        </Point>
    </Base>
</ResultSet>

次に、出発駅の平均待ち時間を含まない結果を取得してみます。

https://api.ekispert.jp/v1/xml/search/multipleRange?key=アクセスキー&baseList=新宿&upperMinute=15&waitAverageTime=false

※ 例のため、分かりやすく駅名称を指定していますが、駅コードの指定を推奨しています。

高円寺駅に対しての結果は以下のようになります。

<ResultSet apiVersion="1.27.0.0" engineVersion="202304_02a">
    :
    <Point>
        <Station code="22671">
            <Name>高円寺</Name>
            <Type>train</Type>
        </Station>
        <Prefecture code="13">
            <Name>東京都</Name>
        </Prefecture>
        <Cost baseIndex="1">
            <!-- 所要時間は8分 -->
            <Minute>8</Minute>
            <TransferCount>0</TransferCount>
        </Cost>
    </Point>
    :
    <Base index="1">
        <Point>
            <Station code="22741">
                <Name>新宿</Name>
                <Type>train</Type>
            </Station>
            <Prefecture code="13">
                <Name>東京都</Name>
                </Prefecture>
        </Point>
    </Base>
</ResultSet>