Document storing leaderboard scores
authorChristian Weiske <[email protected]>
Wed, 16 Oct 2024 16:36:18 +0000 (18:36 +0200)
committerChristian Weiske <[email protected]>
Wed, 16 Oct 2024 16:36:18 +0000 (18:36 +0200)
Related: https://codeberg.org/gamestick-fans/pjgsapi/issues/6

README.rst
api/l2.gamestickservices.net/api-rest-game-xxx-save-score-yyy-extend.response.json [new file with mode: 0644]
api/l2.gamestickservices.net/api-rest-game-xxx-save-score-yyy-extend.rst [new file with mode: 0644]

index b060d81d095acddea14b7dc5f33a924a0a849b1a..30ef503d0f5bac4d45323fb04d8ce0be59abcf14 100644 (file)
@@ -17,6 +17,7 @@ gaming console.
 .. include:: api/l2.gamestickservices.net/api-rest-analytics-application-event-analytics-event.rst
 .. include:: api/l2.gamestickservices.net/api-rest-game-downloadedfreegame-true.rst
 .. include:: api/l2.gamestickservices.net/api-rest-game-xxx-achievements.rst
+.. include:: api/l2.gamestickservices.net/api-rest-game-xxx-save-score-yyy-extend.rst
 .. include:: api/l2.gamestickservices.net/api-rest-connect-stick-stick-xxx.rst
 .. include:: api/l2.gamestickservices.net/api-rest-parentcontroll-change-agerating-xxx-yyy.rst
 .. include:: api/l2.gamestickservices.net/api-rest-player-profile.rst
diff --git a/api/l2.gamestickservices.net/api-rest-game-xxx-save-score-yyy-extend.response.json b/api/l2.gamestickservices.net/api-rest-game-xxx-save-score-yyy-extend.response.json
new file mode 100644 (file)
index 0000000..6246d20
--- /dev/null
@@ -0,0 +1,5 @@
+{
+    "body": {
+        "success": true
+    }
+}
diff --git a/api/l2.gamestickservices.net/api-rest-game-xxx-save-score-yyy-extend.rst b/api/l2.gamestickservices.net/api-rest-game-xxx-save-score-yyy-extend.rst
new file mode 100644 (file)
index 0000000..7281a2b
--- /dev/null
@@ -0,0 +1,35 @@
+=========================================================================================
+``GET http://l2.gamestickservices.net/api/rest/game/xxx/save-score/yyy/extend/view.json``
+=========================================================================================
+
+Store points in the game-specific leaderboard
+
+
+HTTP request
+============
+Protocol
+  ``http``
+Host
+  ``l2.gamestickservices.net``
+Path
+  ``/api/rest/game/xxx/save-score/yyy/extend/view.json;jsessionid=zzz``
+
+  ``xxx``
+    UUID of the game
+  ``yyy``
+    Score/points (integer)
+  ``zzz``
+    Session ID
+
+
+HTTP response
+=============
+Must be on a single line.
+
+Status code
+  ``200 OK``
+
+Example
+
+.. include:: api-rest-game-xxx-save-score-yyy-extend.response.json
+   :code: