Erreur

L'API ITCare utilise les codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une demande API.

En règle générale :

  • Les codes 2xx indiquent un succès.

  • Les codes 4xx indiquent des paramètres incorrects ou incomplets (par exemple, un paramètre requis a été omis, ou une opération a échoué avec une tierce partie, etc.)

  • Les codes de l'ordre de 5xx indiquent une erreur avec les serveurs d'ITCare.

Ce tableau présente d'autres exemples de codes de réponse HTTP.

Code
Description
Réponse

200

Demande traitée avec succès

Varie en fonction de la demande

201

Objet créé avec succès

Objet créé

202

Ordre de création de l'objet traité avec succès, la demande sera traitée de manière asynchrone

Objet vide ou objet de suivi décrivant le traitement de la demande asynchrone

400

Mauvaise requête - Erreur de syntaxe ou de cohérence dans la requête. Doit être corrigée par l'émetteur

Blanc ou indication de l'erreur à corriger du côté du client

401

Accès non autorisé à la ressource

Vide

403

Accès non autorisé

Vide

404

Ressource non existante

Vide

409

Conflit

Vide

422

Donnée incohérente

Vide

500

Erreur fatale de l'API

Vide

503

Service temporairement indisponible

Vide

ITCare produit également un message d'erreur et un code d'erreur formaté en JSON :


{
    "status": "BAD_REQUEST",
    "errorCode": "INVALID_FIELD_VALUE",
    "errorDesc": "name",
    "errorMessage": "Error on field 'name'
}

Last updated