ステーション
このリソースは、指定された条件に一致するガソリンスタンドのリストを取得します。
このリソースに対するリクエストは、 HTTP GET メソッドを使用します。 検索条件は、検索ジオメトリを含むクエリパラメータによって指定されます。
形状を検索は、次のいずれかになります。
- Prox : 中心と半径の座標によって定義された円形の領域。
- 廊下 : ポイントのセット(緯度 、経度 のペア)および幅として定義されたパス。
- BBOX : 左上の緯度 と経度 、右下の緯度 と経度 で定義された正方形。
リクエスト
このコードブロックは、 proximity()prox
を使用して検索領域を定義する検索要求を示します。
https://fuel-v2.cc.api.here.com/fuel/stations.xml
?prox=52.516667,13.383333,5000
&apiKey={YOUR_API_KEY}
リクエストパラメータ
この表に stations
は、リソースでサポートされている必須およびオプションのリクエストパラメータが記載されています。
パラメーター | 必須です | 説明 |
---|---|---|
app_id - レガシー | はい | クライアント アプリケーションの認証に使用される -20 バイトの Base64 URL セーフエンコード文字列。 すべてのリクエストに認証を含める必要があります。 認証の詳細については、『 Identity & Access Management 開発者ガイド 』を参照してください。 |
app_code - レガシー | はい | クライアント アプリケーションの認証に使用される -20 バイトの Base64 URL セーフエンコード文字列。 すべてのリクエストに認証を含める必要があります。 認証の詳細については、『 Identity & Access Management 開発者ガイド 』を参照してください。 |
apiKey | はい | A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged-in user, you can generate it at https://here-tech.skawa.fun/projects. API Keys never expire but you can disable your API Keys at any time. You cannot have more than two API Keys for one app at the same time. You must include an apiKey with every request. For more information on authentication, see the Identity & Access Management Developer Guide. |
prox | prox 、 bbox または corridor が存在する必要があります | 経度とその中央の緯度 (WGS 84 に準拠 ) で定義された円形の検索エリア。面積の半径をメートル単位で表す整数で、すべてコンマで区切ります。 たとえば 円の最大半径は 200 km です |
bbox | prox 、 bbox または corridor が存在する必要があります | バウンディング ボックスは、左上と右下の角にある緯度 and 経度 (WGS 84 に準拠 ) によって定義されています。 左上と右下のペアはセミコロンで区切り、緯度と経度のペアはコンマで区切ります。 たとえば、バウンディング ボックス値 バウンディング ボックスサイズ ( 幅または高さ ) は 400 km 未満である必要があります。 |
corridor | prox 、 bbox または corridor が存在する必要があります | セミコロンで区切られたポイントのリスト ( カンマで区切られた緯度と経度 WGS 84 の対応する値のペア ) として定義 されたストリップ。たとえば、ドイツからハンブルクへの移動を、マクデブルク経由で指定します。最大廊下エリアは 5000 キロメートル2
|
fueltype | いいえ | 応答に含まれる燃料タイプまたは燃料カテゴリを示すコンマ区切りの整数。 値の数に制限はありません 価格情報が不明なステーションは、既定で結果セットから除外されます。 利用可能な燃料タイプおよびカテゴリの詳細については、「燃料タイプおよびカテゴリ」を参照してください。 |
corridorwidth | いいえ | 廊下の幅 ( メートル ) 。 このパラメータは 最大経路幅は 20km です デフォルト : 5000 件 |
maxresults | いいえ | 応答に含めることができる結果の最大数。 このパラメータと 、クエリーの デフォルト : 50. |
sortkey | いいえ | 検索結果のリストを並べ替えるための条件。 指定できる値は次のとおりです。
|
sortorder | いいえ | 結果の並べ替え順。 指定できる値は次のとおりです。
デフォルトは asc です |
offset | いいえ | 最初の結果のインデックスを指定する値。 このパラメータと 、クエリーの デフォルト : 0 。 |
showallstations | いいえ | 価格または燃料タイプの情報が不明なガソリンスタンドが結果セットに含まれています。 このパラメーターは fueltype パラメーターと連携して動作します。 指定できる値は次のとおりです。
デフォルトは false です |
imagedimensions | いいえ | UI および帯域幅の要件に合わせて、brand icon イメージの特定の最大サイズを要求します 形式では、目的の幅、目的の高さ、またはその両方を指定して、拡大縮小されたイメージの寸法を指定します 有効なエレメントは次のとおりです。
例 :
注 : 指定した値は、返された画像の寸法の上限として使用されます。 このソリューションでは、小さな画像はスケールアップされず、元の画像の縦横比が維持されます。 |
brand | いいえ | 応答でステーションをフィルタリングするブランドのリスト。 一覧表のブランド名は、コンマで区切ります。 結果には brand 、リストで指定されたものと一致するフィールドを持つステーションのみが含まれます。 大文字と小文字は区別されません。 |
レスポンス
stations
リソースに対するクエリーへの応答の詳細について は、「ガソリンスタンドの応答」を参照してください。