Gestion des erreurs

L’API renvoie les erreurs dans le cadre d’une réponse normale, avec les données qui ont pu être résolues. Une requête peut réussir partiellement, donc vérifier uniquement le code de statut HTTP ne suffit pas pour détecter une erreur.

Erreurs

Chaque erreur est renvoyée dans le tableau errors de premier niveau, aux côtés de data.

message · String

Une description lisible par un humain de l’erreur.

locations · Array

La ligne et la colonne de la requête où l’erreur s’est produite.

path · Array

Le chemin vers le champ à l’origine de l’erreur, par exemple ["vehicleList"].

extensions.exception.code · String

Un code d’erreur lisible par une machine. Utilisez ce champ pour gérer les erreurs par programmation, plutôt que de vous baser sur message.

extensions.exception.status · Integer

Le code de statut HTTP correspondant à l’erreur, par exemple 403.

extensions.exception.message · String

Une description lisible par un humain de l’erreur, identique au champ message de premier niveau.

extensions.exception.response · String

Le corps de la réponse de l’exception sous-jacente, souvent identique à message.

Localisation

Pour gérer et localiser correctement les messages d’erreur, utilisez extensions.exception.code plutôt que message. Pour une description de la signification de chaque code, consultez la page de l’opération dans la référence API. message ne doit servir que de contexte pour les développeurs, et ne pas être affiché aux utilisateurs finaux.

Merci pour votre retour.

Ce contenu vous a-t-il été utile ?