駅情報・路線情報・会社情報を全件取得する
駅情報、運行路線情報、平均路線情報、会社情報では、offset
パラメータを使用することで、情報を全件取得することができます。
関連URL
手順
以降では、駅情報を例にして、全件取得する方法を説明します。
運行路線情報、平均路線情報、会社情報においても、同様の手順で、全件取得することができます。
1. 駅一覧を取得する
駅情報を用いて、駅一覧を取得します。
駅情報を全件取得するには、まず取得可能なデータが何件あるかを、レスポンスに付与されるデータの全件数ResultSet/max
で確認する必要があります。
リクエスト例では、typeパラメータにtrain
を指定して、鉄道駅に絞り込んだ駅一覧を取得しています。
GET /v1/xml/station?type=train
<ResultSet apiVersion="1.27.0.0" max="9151" offset="1" engineVersion="201805_01a">
<Point>
<Station code="26242">
<Name>相生(兵庫県)</Name>
<Type>train</Type>
<Yomi>あいおい</Yomi>
</Station>
<Prefecture code="28">
<Name>兵庫県</Name>
</Prefecture>
<GeoPoint longi="134.28.36.29" lati="34.48.54.29" longi_d="134.476749" lati_d="34.815082" gcs="tokyo"/>
</Point>
<Point>
<Station code="24360">
<Name>相生(岐阜県)</Name>
<Type>train</Type>
<Yomi>あいおい</Yomi>
</Station>
<Prefecture code="21">
<Name>岐阜県</Name>
</Prefecture>
<GeoPoint longi="136.57.12.89" lati="35.42.42.69" longi_d="136.953583" lati_d="35.711861" gcs="tokyo"/>
</Point>
:
データの全件数ResultSet/max
が取得できます。今回のリクエスト例では、9151件でした。
2. offsetパラメータを用いて全件取得する
駅情報は、一度に100件までのデータが取得できます。
1のレスポンスで取得できるデータの全件数ResultSet/max
で示されている全件を取得したい場合は、offsetパラメータの値を繰り上げて取得してください。
リクエスト例では、101件目から200件目までの駅が返ります。9151件の全ての駅を取得するには、offsetパラメータを9101
まで100件ずつずらしてリクエストを送ります。
GET /v1/xml/station?type=train&offset=101
<ResultSet apiVersion="1.27.0.0" max="9151" offset="101" engineVersion="201805_01a">
<Point>
<Station code="20621">
<Name>赤川</Name>
<Type>train</Type>
<Yomi>あかがわ</Yomi>
</Station>
<Prefecture code="2">
<Name>青森県</Name>
</Prefecture>
<GeoPoint longi="141.12.46.9" lati="41.15.54.79" longi_d="141.212805" lati_d="41.265221" gcs="tokyo"/>
</Point>
<Point>
<Station code="21840">
<Name>赤城</Name>
<Type>train</Type>
<Yomi>あかぎ</Yomi>
</Station>
<Prefecture code="10">
<Name>群馬県</Name>
</Prefecture>
<GeoPoint longi="139.16.46.9" lati="36.25.21.39" longi_d="139.279472" lati_d="36.422611" gcs="tokyo"/>
</Point>
: