PATCH /website/update-maintenance
Modifie le status de la maintenance du site.
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 :
| Nom | Type | Dans | Requis | Description |
|---|---|---|---|---|
id | number | body | ✅ | L’identifiant unique du site (1) |
status | number | body | ✅ | Le status du site |
🧾 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 site |
status | number | ❌ | Le status du site |
📤 Exemple de requête
http://0.0.0.0/api/website/update-maintenance
Et dans le body mettre par exemple pour changer le status du site :
{
"id" : 1,
"status": 0
}
📥 Exemple de réponse
Voici un exemple de réponse si la modification a été effectuée avec succès (code 200) :
{
"id" : 1,
"status": 0
}
⛔ 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 |
| 409 | Conflict | Conflit avec des données existantes |
| 500 | Internal Server Error | Erreur interne du serveur |
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 compte n'a pas été trouvé dans la base de données.
{
"message": "No value present",
"code": 404
}