Aller au contenu principal

GET /parkour/get-all-maps

version 2.0.0

Récupérer les informations de toutes les maps.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

  • Corail
  • Zelta
  • Axel

🧾 Paramètres

Aucun paramètre n'est requis pour cette requête.

🧾 Réponse

Les données que l'API retournera avec le succès de la requête :

NomTypeNullableDescription
idnumberL'ID de la map
namestringLe nom de la map
enableboolSi la map est active
spawnLocationstringLe point d'apparition de la map
difficultystringLa difficulté de la map

📤 Exemple de requête

http://0.0.0.0/api/parkour/get-all-maps

📥 Exemple de réponse

Si des parkours sont trouvés (code 200) :

[
{
"id": 1,
"name": "Test 1",
"enable": false,
"spawnLocation": "{x:100, y:65, z:1296, world:world, pitch:50, yaw:50}",
"difficulty": "easy"
},
{
"id": 2,
"name": "Test 2",
"enable": true,
"spawnLocation": "{x:767, y:52, z:75, world:world, pitch:50, yaw:50}",
"difficulty": "easy"
},
{
"id": 3,
"name": "Test 3",
"enable": true,
"spawnLocation": "{x:76, y:59, z:6345, world:world, pitch:50, yaw:50}",
"difficulty": "hard"
}
]
info

Si aucun parkour n'est trouvé, l'API retourne un tableau vide.

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
500Internal Server ErrorErreur interne du serveur
Attention !

En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !

En cas d'erreur voici les informations que retourne l'API

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe message de l'API expliquant l'erreur

Exemple avec l'erreur 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas les droits pour cette requête.

{
"message": "Access Denied",
"code": 403
}