Messages d’erreur de l’API

Lorsqu’une demande d’API échoue en raison d’erreurs de requête ou d’erreurs de serveur, un message de réponse d’erreur est renvoyé au format JSON.

Un message de réponse d’erreur est renvoyé au format JSON, même pour les points de terminaison qui prennent en charge d’autres types MIME. Le message de réponse d’erreur comprend le message d’erreur lui-même, une description de l’erreur, un code d’erreur unique pour le point de terminaison, un message de réponse HTTP et un code de réponse HTTP.

La réponse d’erreur comprend les champs suivants :

  • message : le message d’erreur

  • Détails : un champ pour des informations supplémentaires, qui peuvent ou non être renseignées

  • Description : Description de l’erreur spécifique

  • code : code de réponse d’erreur unique

  • http_response :

    • message : message de réponse HTTP

    • code : code d’état de réponse HTTP

Par exemple, la requête d’API suivante tente d’obtenir des informations sur un jeu de référence inexistant appelé « test-set »

Un code de réponse HTTP et le message de 404 réponse d’erreur JSON suivant sont renvoyés :

Le tableau suivant fournit plus d’informations sur les catégories d’erreurs de réponse HTTP renvoyées par l’API REST JSA :

Catégorie d’erreur HTTP

Code de réponse HTTP

Message de réponse HTTP

CHOIX MULTIPLES

300

The requested resource corresponds to any one of a set of representations, each with its own specific location.

DÉMÉNAGÉ DÉFINITIVEMENT

301

The resource has moved permanently. Please refer to the documentation.

TROUVÉ

302

The resource has moved temporarily. Please refer to the documentation.

VOIR AUTRES

303

The resource can be found under a different URI.

NON MODIFIÉ

304

The resource is available and not modified.

UTILISER UN PROXY

305

The requested resource must be accessed through the proxy given by the Location field.

REDIRECTION TEMPORAIRE

307

The resource resides temporarily under a different URI.

MAUVAISE DEMANDE

400

Invalid syntax for this request was provided.

NON AUTORISÉE

401

You are unauthorized to access the requested resource. Please log in.

INTERDIT

403

Your account is not authorized to access the requested resource.

INTROUVABLE

404

We could not find the resource you requested. Please refer to the documentation for the list of resources.

MÉTHODE NON AUTORISÉE

405

This method type is not currently supported.

INACCEPTABLE

406

Acceptance header is invalid for this endpoint resource.

AUTHENTIFICATION PROXY REQUISE

407

Authentication with proxy is required.

DÉLAI DE DEMANDE D’EXPIRATION

408

Client did not produce a request within the time that the server was prepared to wait.

CONFLIT

409

The request could not be completed due to a conflict with the current state of the resource.

PARTI

410

The requested resource is no longer available and has been permanently removed.

LONGUEUR REQUISE

411

Length of the content is required, please include it with the request.

ECHEC DE LA CONDITION PRÉALABLE

412

The request did not match the pre-conditions of the requested resource.

ENTITÉ DE REQUÊTE TROP GRANDE

413

The request entity is larger than the server is willing or able to process.

URI-DE-DEMANDE TROP LONG

414

The request URI is longer than the server is willing to interpret.

TYPE DE MÉDIA NON PRIS EN CHARGE

415

The requested resource does not support the media type provided.

LA PLAGE DEMANDÉE N’EST PAS SATISFAISANTE

416

The requested range for the resource is not available.

L’ATTENTE A ÉCHOUÉ

417

Unable to meet the expectation given in the Expect request header.

ARGUMENTS MANQUANTS

419

The requested resource is missing required arguments.

ARGUMENTS INVALIDES

420

The requested resource does not support one or more of the given parameters.

ENTITÉ NON TRAITABLE

422

The request was well-formed but was unable to be followed due to semantic errors.

ERREUR INTERNE DU SERVEUR

500

Unexpected internal server error.

N’A PAS ÉTÉ MIS EN ŒUVRE

501

The requested resource is recognized but not implemented.

PASSERELLE DÉFECTUEUSE

502

Invalid response received when acting as a proxy or gateway.

SERVICE INDISPONIBLE

503

The server is currently unavailable.

DÉLAI D’EXPIRATION DE LA PASSERELLE

504

Did not receive a timely response from upstream server while acting as a gateway or proxy.

VERSION HTTP NON PRISE EN CHARGE

505

The HTTP protocol version used in the request message is not supported.

ÉCHEC D’INITIALISATION

550

A failure occurred during initialization of services. API will be unavailable.