Skip to main content

Oggetto ritornato dalla API in caso di errore

Quando un qualsiasi errore si verifica in fase di interazione con le API, verrà ritornato un oggetto del tipo

{
    "type": "about:blank",
    "title": "Bad Request",
    "status": 400,
    "detail": "CA validation error",
    "instance": "/api/v1/ca-registry/validate",
    "traceId": "a10f77b67e485faa68c586859340f5b9",
    "code": "GE_001",
    "errors": {
        "owner.sex": "Not a valid choice"
    }
}

dove:

  • traceId è un importante dato da comunicare per il troubleshooting. Includerlo SEMPRE nelle richieste di assistenza.
  • code e detail forniscono un maggiore livello di dettaglio rispetto all'errore riscontrato
  • in caso di problemi di validazione degli input, errors riporta l'elenco dei campi che hanno concorso all'errore con relativa causa