From: Christian Weiske <cweiske@cweiske.de>
Date: Thu, 1 Jun 2023 19:36:23 +0000 (+0200)
Subject: Achievement listing API
X-Git-Url: https://git.cweiske.de/playjam-gamestick-api-docs.git/commitdiff_plain/dcfc34d11055897a5a44a308b7630c586dae8bf9

Achievement listing API
---

diff --git a/README.rst b/README.rst
index 05075ca..b915901 100644
--- a/README.rst
+++ b/README.rst
@@ -16,6 +16,7 @@ gaming console.
 .. 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
+.. include:: api/l2.gamestickservices.net/api-rest-user-game-xxx-achievement-list.rst
 .. include:: api/l2.gamestickservices.net/api-rest-wallet-payment-game-init-transaction-do.rst
 .. include:: api/l2.gamestickservices.net/api-rest-wallet-payment-topupwallet-init-transaction-do.rst
 .. include:: api/update.gamestickservices.net/check.php.rst
diff --git a/api/l2.gamestickservices.net/api-rest-user-game-xxx-achievement-list.response.json b/api/l2.gamestickservices.net/api-rest-user-game-xxx-achievement-list.response.json
new file mode 100644
index 0000000..00894cc
--- /dev/null
+++ b/api/l2.gamestickservices.net/api-rest-user-game-xxx-achievement-list.response.json
@@ -0,0 +1,17 @@
+{
+    "body": {
+        "success": true,
+        "achievements": [
+            {
+                "id":461,
+                "achievementType": "FIXME",
+                "achievementName": "FIXME",
+                "description": "FIXME",
+                "xpValue": 1,
+                "fileName": "FIXME",
+                "fileUrl": "FIXME",
+                "isCurrentUserOwner": 1
+            }
+        ]
+    }
+}
diff --git a/api/l2.gamestickservices.net/api-rest-user-game-xxx-achievement-list.rst b/api/l2.gamestickservices.net/api-rest-user-game-xxx-achievement-list.rst
new file mode 100644
index 0000000..9fefe84
--- /dev/null
+++ b/api/l2.gamestickservices.net/api-rest-user-game-xxx-achievement-list.rst
@@ -0,0 +1,46 @@
+=========================================================================================
+``GET http://l2.gamestickservices.net/api/rest/user/game/xxx/achievement/list/view.json``
+=========================================================================================
+
+Fetch achievements.
+
+Known usage:
+
+- When "Bloo Kid" starts
+
+
+HTTP request
+============
+Protocol
+  ``http``
+Host
+  ``l2.gamestickservices.net``
+Path
+  ``/api/rest/user/game/xxx/achievement/list/view.json;jsessionid=yyy``
+
+  ``xxx``
+    UUID of the game
+  ``yyy``
+    Session ID
+
+
+HTTP response
+=============
+The response must be on one single line!
+
+At least "Bloo Kid" only cares about the ID.
+The other properties must exist (JSON parsing fails otherwise),
+but their values are not used.
+
+The ``id`` seem to be registered on the server.
+
+Status code
+  ``200 OK``
+
+.. include:: api-rest-parentcontroll-change-agerating-xxx-yyy.response-success.json
+   :code:
+
+Known achievement IDs:
+
+``461``
+  Bloo Kid: Triple Hit