API Merci Facteur /listErrors : Obtenir la liste des erreurs possiblement retournées par l'API.

Base URL API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service

Endpoint API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service/listErrors

← Retour à la liste des endpoints de l'API Merci Facteur

← Voir ce endpoint dans la doc Swagger

GET /listErrorsObtenir la liste des erreurs possiblement retournées par l'API.
 
Voir dans Swagger →

Vous pouvez personnaliser tous les messages d'erreur en fonction des codes d'erreur retournés par l'API. Chaque erreur est identifiée par un code d'erreur qui ne changera jamais. Ce code d'erreur est retourné dans l'entête (en erreur 400 ou 401), ainsi que dans le résultat tel que result[error][code].

Paramètres

NomInTypeDescription
ww-service-idheaderstringVotre service Id
ww-access-tokenheaderstringUn access token valide

Request body

Aucun body.

Réponses

HTTP 200 — Objet contenant l'ensemble des codes d'erreur ainsi que leurs significations.

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorstringle code d'erreur en cas d'erreur
listErrorsobjectObjet contenant la correspondance entre chaque code d'erreur et sa signification.
PropriétéTypeDescription
ERROR_CODE_1stringSigification de ce code d'erreur
ERROR_CODE_2stringSigification de ce code d'erreur
ERROR_CODE_3stringSigification de ce code d'erreur
ETCstringetc.
HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant
HTTP 401 — Erreur authentification (code d'erreur dans l'entête : token invalide ou expiré, service-id incorrecte, IP non autorisée)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant


imprimé en france depuis 2004