Aller au contenu principal

GET /freebuild/get-worlds

version 2.0.0

Récupérer les informations de tous les mondes.

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

🧾 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 du monde
namestringLe nom du monde
ownerIdnumberL'id du propriétaire du monde
typestringLe type du monde
statestringSi le monde est déjà charger
lastUsedstringLe dernier moment où quelqu'un était dessus
statusstringSi le monde est public
spawnLocationstringLa position du spawn
gameruleRandomTickSpeednumberLa valeur du random tick speed
gameruleDaylightCycleboolSi il y a le cycle jour nuit
gamerulePvpboolSi le pvp est activé
gamerulePlayerDamageboolSi les joueurs peuvent prendre des dégâts
tagstringLe tag du monde

📤 Exemple de requête

http://0.0.0.0/api/freebuild/get-worlds

📥 Exemple de réponse

Si le monde est trouvé (code 200) :

[
{
"id": 42,
"name": "monde de fous",
"ownerId": 1,
"type": "FLAT",
"state": "Loaded",
"lastUsed": "2023-10-01T12:00:00Z",
"status": "PRIVATE",
"spawnLocation": "0, 83, 0",
"gameruleRandomTickSpeed": 1,
"gameruleDaylightCycle": "true",
"gamerulePvp": "false",
"gamerulePlayerDamage": "true",
"tag": "MDF"
},
{
"id": 65,
"name": "monde de corail",
"ownerId": 5,
"type": "FLAT",
"state": "Loaded",
"lastUsed": "2023-10-01T12:00:00Z",
"status": "PRIVATE",
"spawnLocation": "0, 83, 0",
"gameruleRandomTickSpeed": 2,
"gameruleDaylightCycle": "true",
"gamerulePvp": "false",
"gamerulePlayerDamage": "true",
"tag": "MDF"
}
]
info

Si aucun monde 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
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 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
}