Tabella dei contenuti
API VERSIONE GA 2.0
La versione GA 2.0 di SEND aggiunge la funzionalità di annullamento della notifica da parte del mittente e la visualizzazione delle cause che conducono all'irreperibilità totale.
Definizione OpenAPI: https://raw.githubusercontent.com/pagopa/pn-delivery/GA2.0/docs/openapi/api-external-b2b-pa-bundle.yaml
Annullamento della notifica
L'annullamento della notifica può essere effettuata da via B2B o via portale mittente.
Per supportare questa funzionalità sono state effettuati i seguenti interventi sulla API:
- Aggiunta l'operation notificationCancellationPUT /delivery-push/v2.0/notifications/cancel/{iun}: Permette l'annullamento di una notifica immettendo lo IUN nel path, restituendo una presa in carico, il processo di annullamento si completa poi in maniera asincrona.
- Nuova versione dell'operation retrieveSentNotificationV20GET /delivery/v2.0/notifications/sent/{iun}: permette di visualizzare le specifiche della notifica inserendo lo IUN anche delle notifiche annullate con i dettagli di stato e di eventi relativi l'annullamento.
- Aggiunti eventi di timeline collegati all'annullamento della notifica:
- `NOTIFICATION_CANCELLATION_REQUEST` - Richiesta di annullamento di una notifica
- `NOTIFICATION_CANCELLED` - Notifica annullata
Visualizzazione cause irreperibilità totale
Aggiunto elemento nuovo di timeline PREPARE_ANALOG_DOMICILE_FAILURE che riporta nei dettagli nell'elemento failureCausela motivazione del fallimento:
- D00: Indirizzo non trovato
- D01: Indirizzo non valido
- D02: Indirizzo coincidente con quello del primo tentativo
Modifiche agli stream di stato e degli eventi di timeline
Questa versione introduce
- lo stato CANCELLED
- gli elementi di timeline
- NOTIFICATION_CANCELLATION_REQUEST
- NOTIFICATION_CANCELLED
- PREPARE_ANALOG_DOMICILE_FAILURE
NOTA: Per mantenere la retro-compatibilità con la versione precedente questi elementi non sono inseriti negli stream a meno che non siano esplicitamente indicati. Per cui gli stream creati senza indicazione del filtro degli stati della notifica o degli eventi di timeline NON riporteranno questi nuovi elementi. Per ottenere anche i nuovi elementi sarà necessario modificare lo stream indicando nel filtro (elemento filterValues) tutti gli stati e tutti gli eventi di timeline di interesse per i processi del mittente.
