2.1 山行記録
各APIへのアクセス方法は、2. API(基本仕様)をご確認ください。
1. 山行記録リストの取得(getReclist) ※OAuth認証不要
ヤマレコに登録されている山行記録を取得する。
HTTP GETで /getReclist/(page) にアクセスすると、全体の記録一覧が取得できる。取得したデータの並び順は、記録の作成日の降順(新しく登録されたものから順に並ぶ)。
HTTP GETで /getReclist/(page) ?max_id=(max_id)にアクセスすると、max_idで指定した山行記録より前に登録された山行記録一覧が取得できる。
HTTP GETで /getReclist/user/(userID)/(page) にアクセスすると、指定したユーザーの記録一覧が取得できる。取得したデータの並び順は、入山日(start)の降順(最近のものから順に並ぶ)。
HTTP GETで /getReclist/group/(groupID)/(page) にアクセスすると、指定したグループの記録一覧が取得できる。取得したデータの並び順は、入山日(start)の降順(最近のものから順に並ぶ)。
リクエスト
レスポンス
2. 記録の検索(searchRec) ※要OAuth認証
ヤマレコに登録されている記録を検索する。HTTP POSTで /searchRecにアクセスする。
見つからない場合はエラーが返される。
なお、モバイルデバイス専用の制限がかかります(山行記録を過去1年以内に公開していない場合かつスタンダードプランのユーザーは利用できません)。Webサイトでの利用など、制限解除を希望される場合は本番サイト公開の際にご連絡ください。
リクエスト
レスポンス
→ 記録リストの取得(getReclist)と同様
3. 記録の取得(getRec) ※要OAuth認証
ヤマレコに登録されている記録を取得する。
HTTP GETで /getRec/(rec_id) にアクセスすると、該当する記録の情報が取得できる。
リクエスト
レスポンス
4. コメントリストの取得(getCommentlist) ※要OAuth認証
コメントのリストを取得する。
HTTP GETで /getCommentlist/(rec_id) にアクセスすると、該当する記録についたコメントの情報が取得できる。
リクエスト
レスポンス
5. 記録の新規登録(createRec) ※要OAuth認証
新しく山行記録を登録する。メンバーに自動的に登録者が追加され個人の記録として登録される。
HTTP POSTで/createRecにアクセスする。
リクエスト
レスポンス
6. 記録の編集(editRec) ※要OAuth認証
登録済みの山行記録を編集する。rec_id以外はcreateRecと同様。
HTTP POSTで/editRecにアクセスする。
リクエスト
レスポンス
7. 記録の削除(deleteRec) ※要OAuth認証
登録済みの山行記録を削除する。
HTTP POSTで/deleteRecにアクセスする。
関連する写真およびGPSログなどの情報も含めて全ての情報が削除される。
リクエスト
レスポンス
8. 写真の追加登録(addPhoto) ※要OAuth認証
登録済みの記録に写真を追加登録する。
HTTP POSTで /addPhoto/(rec_id)/(type)/(maxsize)/(rotate) にアクセスする。
メッセージボディには写真データを格納し、パラメータはURLに含めて送信する。
リクエスト
レスポンス
9. 写真の編集(editPhoto) ※要OAuth認証
登録済みの写真の編集をする。
HTTP POSTで /editPhote にアクセスする。
リクエスト
レスポンス
10. 写真の削除(deletePhoto) ※要OAuth認証
登録済みの写真の編集をする。該当する写真が存在しない場合でも、エラーは発生しない。
HTTP POSTで /deletePhote にアクセスする。
リクエスト
レスポンス
11. 感想の登録(addNote) ※要OAuth認証
登録済みの記録に感想を登録する。1人に1つのみ感想が登録できて、すでに登録済みの場合はエラーが返答される。
HTTP POSTで /addNote にアクセスする。
リクエスト
レスポンス
12. 感想の編集(editNote) ※要OAuth認証
登録済みの感想を変更する。未登録の場合はエラーが返答される。
HTTP POSTで /editNote にアクセスする。
リクエスト
レスポンス
13. 感想の削除(deleteNote) ※要OAuth認証
登録済みの感想を変更する。該当する感想が存在しない場合でも、エラーは発生しない。
HTTP POSTで /deleteNote にアクセスする。
リクエスト
レスポンス
14. GPSログの登録(addTrack) ※要OAuth認証
登録済みの記録にGPSログを登録する。
HTTP POSTで /addTrack/(rec_id)/(logtype)/(thinout)/(sensor)/(merge) にアクセスする。
メッセージボディにはGPSログデータを格納し、パラメータはURLに含めて送信する。
リクエスト
レスポンス
※GPSログファイルの上限は5MB程度(5,000,000byte)であり、それ以上のサイズのファイルを登録しようとするとエラーが応答されます。
応答までの時間も長くなりますので、ファイルサイズが大きくなる場合は間引きなどをしてから登録いただくこともご検討ください。
15. GPSログの削除(deleteTrack) ※要OAuth認証
登録済みのGPSログを変更する。該当するGPSログが存在しない場合でも、エラーは発生しない。
HTTP POSTで /deleteTrack にアクセスする。
リクエスト
レスポンス
16. 拍手の登録(addCheer) ※要OAuth認証
登録済みの記録に拍手をする。1人につき1回のみ拍手が登録できて、すでに拍手済みの場合はエラーが返答される。
HTTP POSTで /addCheer にアクセスする。
リクエスト
レスポンス
17. 拍手の削除(deleteCheer) ※要OAuth認証
登録済みの拍手を削除する。該当する拍手が存在しない場合でも、エラーは発生しない。
HTTP POSTで /deleteCheer にアクセスする。
リクエスト
レスポンス
18. 拍手数の取得(getCheerlist) ※要OAuth認証
拍手のリストを取得する。
HTTP GETで /getCheerlist/(type)/(id) にアクセスすると、該当する対象についた拍手の情報が取得できる。
リクエスト
レスポンス
19. コメントの登録(addComment) ※要OAuth認証
登録済みの記録にコメントを残す。
HTTP POSTで /addComment にアクセスする。
リクエスト
レスポンス
20. コメントの削除(deleteComment) ※要OAuth認証
登録済みのコメントを削除する。該当するコメントが存在しない場合でも、エラーは発生しない。
HTTP POSTで /deleteComment にアクセスする。
リクエスト
レスポンス
21. 記録と計画の関連付け(relatePlanAndRec) ※要OAuth認証
登録済みの記録にコメントを残す。
HTTP POSTで /relatePlanAndRec にアクセスする。
計画及び記録の両方の編集権限がない場合はエラーになる。
計画または記録とすでに関連付けがある場合は関連付けが上書きされる。
リクエスト
レスポンス