Aller au contenu principal

PATCH /pack/update-pack

version 2.0.0

Modifie une ou plusieurs informations d'un pack de cosmetic.

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
  • Site

🧾 Paramètres

Tous les paramètres sont à envoyer dans le corps de la requête :

NomTypeDansRequisDescription
idnumberBodyL'ID du pack de cosmétique
namestringBodyLe nom du pack de cosmétique
descriptionstringBodyLa description du pack de cosmétique
pricenumberBodyLe prix du pack

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'ID du pack de cosmétique
namestringLe nom du pack de cosmétique
descriptionstringLa description du pack de cosmétique
pricenumberLe prix du pack

📤 Exemple de requête

http://0.0.0.0/api/pack/update-pack
{
"id": 0,
"price": 3000000
}

📥 Exemple de réponse

Voici un exemple de réponse si la modification a été effectuée avec succès (code 200) :

{
"id": 0,
"name": "Pack fondateur",
"description": "Le pack des fondateurs",
"price": 3000000
}

⛔ 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 pack n'a pas été trouvé dans la base de données.

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