Aller au contenu principal

GET /parkour/get-map

version 2.0.0

Récupérer les informations d’une map.

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

Le paramètre suivant est requis dans l’URL pour identifier le badge :

NomTypeDansRequisDescriptionValeur par default
idnumberURLL'ID de la map

🧾 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-map?id=2

📥 Exemple de réponse

Si le parkour est trouvé (code 200) :

{ 
"id": 2,
"name": "Test 2",
"enable": false,
"spawnLocation": "{x:100, y:65, z:1296, world:world, pitch:50, yaw:50}",
"difficulty": "easy"
}

⛔ 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
404Not foundEntité introuvable
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 404 Not found :

Ici par exemple, l'erreur 404 signifie que le parkour n'a pas été trouvé dans la base de données.

{
"message": "No value present",
"code": 404
}