Aller au contenu principal

POST /bot/create-birthday

version 2.0.0

Créer un anniversaire pour une personne.

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

Les champs suivants sont attendus dans le corps de la requête :

NomTypeDansRequisDescriptionValeur par default
discordIdstringBodyL'identifiant Discord de la personne
birthdaystringBodyLa date d’anniversaire (format YYYY-MM-DD)

🧾 Réponse

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

NomTypeNullableDescription
discordIdstringL'identifiant Discord de la personne
birthdaystringLa date d’anniversaire (format YYYY-MM-DD)

📤 Exemple de requête

Voici un exemple d’appel à cette route :

http://0.0.0.0/api/bot/create-birthday

Et dans le body mettre par exemple :

{
"discordId": "213350119184138241",
"birthday": "2000-01-01"
}

📥 Exemple de réponse

Si l’anniversaire est bien créé (code 201) :

{
"discordId": "213350119184138241",
"birthday": "2000-01-01"
}

⛔ 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
409ConflictConflit avec des données existantes
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 409 Conflict :

Ici par exemple, l'erreur 409 signifie que la base de donnée a rencontré une erreur lors de l'ajout du nouvel anniversaire. Dans notre cas, l'id 213350119184138241 est déjà enregistré.

{
"message": "A birthday with the discordId '213350119184138241' already exists",
"code": 409
}