運動会履歴登録API

1.概要

運動会ミッションを達成した際に履歴を登録します。

※本APIは開催中の運動会に対して、
プラットフォーム上で参加表明済(チームが決定している)ユーザーが対象となります。
参加していないユーザーからのリクエストについてはstatus code:500が返されます。
500が返される場合は、該当ユーザーでログイン後、
プラットフォームのトップページから運動会へのリンクを選択し、チームを決定させてください。

2.リクエスト

2.1 エンドポイント

http://gpf-api.[対象ドメイン]/api/athletic

2.2 HTTPメソッド

HTTPメソッド 機能
GET
PUT
POST 運動会履歴を登録する
DELETE

2.3 クエリパラメータ
uuid(必須)

フォーマット 内容 備考
半角英数 ユーザーを特定する識別キー

game_code(必須)

フォーマット 内容 備考
半角英数記号 ゲームを特定する為のコード GAME_CODEはゲーム追加申請時にお知らせする値になります。

code(必須)

フォーマット 内容 備考
半角英数 対象のミッションコード、
及び結果コードをハイフンで繋いだもの
例:
バトル(勝利) battle-win
バトル(敗北) battle-lose
運動会ミッション申請完了時にお知らせするコード

hash(必須)

フォーマット 内容 備考
半角英数 データ改竄防止のためのハッシュキー SHA1(uuid + game_code + code + api_key(ゲーム追加申請時にお知らせする値))

3.レスポンス

パラメータ 内容 フォーマット
status_code 処理結果のステータスコード 数字
status_msg ステータスメッセージ 文字列

X.サンプル

X.1 付与完了後のレスポンス

{ "status_code":"200", "status_msg":"成功" } 

X.2 エラー時のレスポンス例

{ "status_code":400, "status_msg":"パラメータ不足エラー" }