GET /freebuild/get-world

version 2.0.0

Récupérer les informations d’un monde.

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

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

Nom	Type	Dans	Requis	Description	Valeur par default
id	number	URL	✅	L'id du monde	❌

🧾 Réponse

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

Nom	Type	Nullable	Description
id	number	❌	L'id du monde
name	string	❌	Le nom du monde
ownerId	number	❌	L'id du propriétaire du monde
type	string	❌	Le type du monde
state	string	❌	Si le monde est déjà charger
lastUsed	string	❌	Le dernier moment où quelqu'un était dessus
status	string	❌	Si le monde est public
spawnLocation	string	✅	La position du spawn
gameruleRandomTickSpeed	number	❌	La valeur du random tick speed
gameruleDaylightCycle	bool	❌	Si il y a le cycle jour nuit
gamerulePvp	bool	❌	Si le pvp est activé
gamerulePlayerDamage	bool	❌	Si les joueurs peuvent prendre des dégâts
tag	string	✅	Le tag du monde

📤 Exemple de requête

http://0.0.0.0/api/freebuild/get-world?id=42

📥 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"
}

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
404	Not found	Entité introuvable
500	Internal Server Error	Erreur 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

Nom	Type	Description
code	number	Le code d'erreur que retourne la requête
message	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 404 Not found :

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

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