2.3 共通/その他
各APIへのアクセス方法は、2. API(基本仕様)をご確認ください。
1. エリアリストの取得(getArealist) ※OAuth認証不要
1. エリアリストの取得(getArealist) ※OAuth認証不要
ヤマレコで定義されているエリア定義を取得する。
HTTP GETで /getArealist にアクセスする。
リクエスト: パラメータなし
レスポンス
2. ジャンルリストの取得(getGenrelist) ※OAuth認証不要
2. ジャンルリストの取得(getGenrelist) ※OAuth認証不要
ヤマレコで定義されているジャンル定義を取得する。
HTTP GETで /getGenrelist にアクセスする。
リクエスト: パラメータなし
レスポンス
3. 地名データの検索(searchPoi) ※OAuth認証不要
3. 地名データの検索(searchPoi) ※OAuth認証不要
ヤマレコに登録されている地名データを検索する。HTTP POSTで /searchPoiにアクセスする。
見つからない場合はエラーが返される。
リクエスト
レスポンス
4. 近隣の地名データ一覧(nearbyPoi) ※OAuth認証不要
4. 近隣の地名データ一覧(nearbyPoi) ※OAuth認証不要
指定された地点に近い地名データを検索する。HTTP POSTで /nearbyPoiにアクセスする。
見つからない場合はエラーが返される。
リクエスト
レスポンス
searchPoiのレスポンスとほぼ同様。
poilistにdistance(検索した場所からの距離(km))のパラメータ(Float型)が追加される。
5. 地名データのデータ種別リストの取得(getTypelist) ※OAuth認証不要
5. 地名データのデータ種別リストの取得(getTypelist) ※OAuth認証不要
地名データ用のデータ種別定義を取得する。
HTTP GETで /getTypelist にアクセスする。
リクエスト: パラメータなし
レスポンス
6. ユーザー情報の取得(getUserInfo) ※OAuth認証不要
6. ユーザー情報の取得(getUserInfo) ※OAuth認証不要
ユーザーのプロフィール情報を取得する。
HTTP GETで /getUserInfo/(uid) にアクセスすると、該当するユーザーの情報が取得できる。
リクエスト
レスポンス