Gestion des erreurs

En cas d'erreur, le serveur retourne un champ apirequest_uuid qu'il est important d'inclure dans vos demandes de support.

Note

Cette gestion des erreurs est commune à l'éligibilité, aux API orders et services et sera progressivement déployée aux autres endpoints.

Format des erreurs

Nom du champs	Type	Description
apirequest_uuid	string	UUID identifiant l'erreur
details	dict list or null	Liste des détails de l'erreur
error	string	Message de l'erreur

Exemples

HTTP/1.1 500 Internal server error
Content-Type: application/json

{
    "apirequest_uuid": "KOSC_fb3140c4-2305-4185-952d-2aa5c4c2e0f4",
    "details": null,
    "error": "Unable to serve your request"
}

HTTP/1.1 400 Bad request
Content-Type: application/json

{
   "apirequest_uuid": "KOSC_fb3140c4-2305-4185-952d-2aa5c4c2e0f4",
   "details": [
      {
         "field": "reference",
         "errors": ["This field is required."]
      }
   ],
   "error": "Invalid input"
}