Stream di timeline

Configurazione DEFAULT filterValues per stream di eventi di timeline

Configurando uno stream senza specificare alcun elemento in filterValues verranno riportati quelli di DEFAULT, ovvero quelli che hanno ripercussione sul cambiamento di stato del workflow o che riportano dati di interesse per il mittente, sia di carattere legale (es: legal facts) sia di business (es: numero della raccomandata).

Se oltre a questi eventi si vogliono aggiungere altri di interesse (es: SEND_COURTESY_MESSAGE per sapere se sono stati inviati messaggi di cortesia ai destinatari) è sufficiente indicare nel filtro DEFAULT e le categorie di eventi ulteriori.

Questa nuova API espone l'elemento timestamp che rappresenta l'istante in cui la piattaforma ha ricevuto l'informazione. Mentre per gli eventi che si verificano all'esterno della piattaforma (es: consegna della raccomandata) la data in cui si è verificata è indicata in un elemento all'interno dell'oggetto details (es: negli eventi della categoria SEND_ANALOG_FEEDBACK il timestamp è il momento in cui SEND ha ricevuto l'informazione dell'esito della notifica cartacea, mentre elemento notificationDate all'interno dell'oggetto detailsindica la data di consegna della raccomandata).

Nelle tabelle sottostanti sono riportati per ogni categoria di eventi la drescrione, se hanno collegato degli atti a volore legale (LegalFact) e i dettagli di maggior interesse contenuti nell'oggetto details.

NOTA: le date sono espresse nel formato standard ISO 8601, anche detta "Zulu time", che esprime la data UTC (es: 2024-02-29T11:44:17.511990926Z corrisponde alle 12:44:17s del 29/02/2024).

Eventi di timeline nella configurazione DEFAULT

In questa sezione sono indicati gli eventi di timeline inclusi nella configurazione "DEFAULT" e sono stati suddivisi per fase e tipologia del workflow.

Eventi di accettazione/rifiuto notifica

Gli eventi descritti nella tabella sottostante sono relativi al processo di accettazione della notifica.

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

REQUEST_REFUSED

Indica che la richiesta di notifica è stata rifiutata per un fallimento in fase di validazione

  • notificationCost: costo della notifica rifiutata per il mittente

  • refusalReasons:

    • detail: motivo del rifiuta della notifica (es: Validation failed, address is not valid. Error=Invalid Address, Cap, City and Province)

    • errorCode: codice identificati dell'errore (es: NOT_VALID_ADDRESS)

REQUEST_ACCEPTED

Indica che la richiesta di notifica è stata accettata a seguito dei controlli di validazione

SENDER_ACK

Attestazione di presa in carico della notifica

-

Eventi del workflow digitale

Gli eventi descritti nella tabella sottostante sono relativi al processo del workflow digitale, compreso l'eventuale invio dell'AAR tramite raccomandata semplice.

Per i dettagli dei co

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

SEND_DIGITAL_DOMICILE

Indica un tentativo di invio digitale della notifica

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress: indirizzo digitale del destinatario

    • type: PEC

    • address: indirizzo PEC

  • digitalAddressSource: tipologia del domicilio digitale (PLATFORM, SPECIAL, GENERAL)

SEND_DIGITAL_FEEDBACK

Indica la ricezione di un esito ad un invio digitale

PEC_RECEIPT File in formato EML che attesta la consegna della PEC

  • recIndex: posizione del destinatario nell'array recipients

  • responseStatus: esito dell'invio digitale (es: OK)

  • notificationDate: data di consegna o mancata consegna della PEC.

  • deliveryFailureCause: Eventuali errori (*)

  • deliveryDetailCode: Codice di consegna (*)

DIGITAL_SUCCESS_WORKFLOW

Indica il completamento con successo il workflow di invio digitale.

DIGITAL_DELIVERY

Attestazione generata alla conclusione dei tentativi di invio sui domicili digitali disponibili, nel caso si siano completati con un evento di consegna

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress: indirizzo digitale del destinatario

    • type: PEC

    • address: indirizzo PEC

DIGITAL_FAILURE_WORKFLOW

Indica il completamento con fallimento il workflow di invio digitale: tutti i tentativi di invio ai domicili digitali sono falliti

DIGITAL_DELIVERY

Generata alla conclusione dei tentativi di invio sui domicili digitali disponibili, nel caso si siano completati con una mancata consegna

  • recIndex: indica l'indice dell'array del destinatario per il quale è fallito l'invio digitale

SEND_SIMPLE_REGISTERED_LETTER

Indica l'invio di raccomandata semplice

  • recIndex: posizione del destinatario nell'array recipients

  • analogCost: costo dell’invio cartaceo

  • physicalAddress: indirizzo fisico del destinatario

SEND_SIMPLE_REGISTERED_LETTER_PROGRESS

Indica la ricezione di informazioni relative all'invio della raccomandata semplice

  • recIndex: posizione del destinatario nell'array recipients

  • registeredLetterCode : codice della lettera per il destinatario

  • deliveryDetailCode: codice del dettaglio dell'eveto di progress

(*) Per la decodifica dei codici di deliveryDetailCode all'interno dei details degli eventi si rimanda alla pagina Decodifiche SEND_DIGITAL

Eventi del workflow Analogico

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

SEND_ANALOG_DOMICILE

Invio cartaceo dell’avviso di notifica

  • recIndex: posizione del destinatario nell'array recipients

  • analogCost: costo dell’invio cartaceo

  • productType / serviceLevel : tipologia del prodotto inviato (es: 890/AR)

  • physicalAddress: indirizzo fisico del destinatario

SEND_ANALOG_FEEDBACK

Ricezione esito dell'invio cartaceo

  • recIndex: posizione del destinatario nell'array recipients

  • physicalAddress: indirizzo fisico del destinatario

  • responseStatus: contiene l’esito dell'invio cartaceo. (es: OK, KO)

  • notificationDate: data di consegna o mancata consegna.

  • registeredLetterCode:codice della lettera per il mittente

  • deliveryDetailCode:codice del dettaglio esito invio cartaceo

  • deliveryFailureCause: causa del fallimento della consegna

  • serviceLevel: tipologia del prodotto inviato (es: 890/AR)

  • newAddress: Eventuale indirizzo fisico a seguito di indagine svolta in loco da parte dell'addetto al recapito postale

ANALOG_SUCCESS_WORKFLOW

Completato con successo il workflow di invio cartaceo.

  • recIndex: posizione del destinatario nell'array recipients

  • physicalAddress: indirizzo fisico del destinatario

ANALOG_FAILURE_WORKFLOW

Completato con fallimento il workflow di invio cartaceo.

  • recIndex: posizione del destinatario nell'array recipients

  • generatedAarUrl: deposito della AAR

COMPLETELY_UNREACHABLE

Il destinatario è risultato irraggiungibile.

ANALOG_FAILURE_DELIVERY

Attestazione di Deposito di Avviso di Avvenuta Ricezione

  • recIndex: posizione del destinatario nell'array recipients

(*) Per la decodifica dei codici di e deliveryFailureCause e deliveryDetailCode all'interno dei details degli eventi di SEND_ANALOG_FEEDBACK si rimanda alla pagina Decodifiche SEND_ANALOG

Eventi di chiusura del workflow

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

REFINEMENT

Perfezionamento per decorrenza termini

  • recIndex: posizione del destinatario nell'array recipients

  • notificationCost: costo della notifica rifiutata per il mittente

  • eventTimestamp: indica la data di perfezionamento della notifica per decorrenza termini

NOTIFICATION_VIEWED

Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)

RECIPIENT_ACCES

Attestazione di avvenuto accesso

  • recIndex: posizione del destinatario nell'array recipients

  • notificationCost: costo della notifica per il mittente

  • eventTimestamp: data di business in cui è stata visualizzata la notifica

  • delegateInfo struttura che contiene le informazione dell'evenutale delegato che ha fatto accesso alla notifica.

    • taxId: codice fiscale del delegato

    • denomination: denominazione delegato

    • delegateType: tipologia delegato PF/PG

NOTIFICATION_CANCELLED

Evento di fine della cancellazione della notifica dal parte del mittente.

  • notificationCost: costo della notifica annullata per il mittente

Altre eventi di timeline

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

NOTIFICATION_RADD_RETRIEVED

Evento di accesso alla notifica tramite RADD

  • recIndex: posizione del destinatario nell'array recipients

  • eventTimestamp: data di consegna della notifica

  • raddType: tipologia soggetto RADD

  • raddTransactionId: identificativo della transazione RADD

Eventi aggiuntivi al DEFAULT

In questo paragrafo sono indicati altri eventi della timeline che non hanno effetto sullo stato della notifica e non hanno una importanza prioritaria per il mittente, ma possono essere interessanti per recuperare delle informazioni di dettaglio. Ricordiamo che questi dati sono mantenuti dalla piattaforma in modo sicuro per 10 anni e sono sempre disponibili per essere recuperati tramite le API.

Eventi di preparazione workflow

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

AAR_GENERATION

Generazione dell’AAR (Avviso di Avvenuta Ricezione)

  • recIndex: posizione del destinatario nell'array recipients

  • generatedAarUrl: url per accedere all'avviso di avvenuta ricezione

SEND_COURTESY_MESSAGE

Invio di un messaggio di cortesia.

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress

    • type: tipologia messaggio di OPT_IN o un messaggio su APPIO, EMAIL o SMS

    • address: indirizzo email o numero di telefono utilizzato per il messaggio.

PROBABLE_SCHEDULING_ANALOG_DATE

Indica che il workflow può essere sospeso per 120h a fronte di un invio di un messaggio di cortesia.

  • recIndex: posizione del destinatario nell'array recipients

  • schedulingAnalogDate: data di inizio del workflow analogico, ritardato a causa di invio di messaggi di cortesia.

Eventi di scelta del workflow

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

PUBLIC_REGISTRY_RESPONSE

Indica la ricezione di un domicilio digitale dai registri nazionali

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress: indirizzo digitale del destinatario

    • type: PEC

    • address: indirizzo PEC

Eventi con evidenze dell'invio

Gli eventi di PROGRESS sono eventi restituiti dai servizi esterni di invio digitale (SEND_DIGITAL_PROGRESS) e cartaceo (SEND_ANALOG_PROGRESS).

Questi eventi possono contenere anche dei legalFact esterni come il messaggio di consegna della PEC (in formato EML) nel caso di invio digitale o le scansioni della ricevuta di consegna, del plico, del avviso di ricevimento, dell'indagine del postino nel caso di invio di raccomandata.

Category

Descrizione evento

LegalFact Atti opponibili

Dettagli Elementi di interesse contenuti

SEND_DIGITAL_PROGRESS

Indica un evento successivo relativo all'invio della PEC.

PEC_RECEIPT *

File in formato EML che attesta la accettazione della PEC

  • recIndex: posizione del destinatario nell'array recipients

  • eventTimestamp: data di business dell'evento

  • digitalAddress: indirizzo digitale del destinatario

SEND_ANALOG_PROGRESS

Indica un evento successivo relativo all'invio cartaceo

ANALOG_DELIVERY* A seconda dei casi sono riportate le scansioni di:

  • Ricevuta di consegna con deliveryDetailCode RECRN001B e documentType AR

  • Scansione Plico con deliveryDetailCode RECRN002B, RECRN004B, RECRN002E, RECRN005B e documentType Plico

  • Avviso di ricevimento con deliveryDetailCode RECRN003B e documentType AR

  • Indagine con deliveryDetailCode RECRN002E e documentType Indagine

  • recIndex: posizione del destinatario nell'array recipients

  • notificationDate: data evento

  • deliveryDetailCode: codice consegna (*)

  • serviceLevel: tipologia di servizio

  • registeredLetterCode: identificativo raccomandata

PREPARE_ANALOG_DOMICILE_FAILURE

Invio cartaceo non possibile: non è stato trovato nessun indirizzo valido per predisporre il tentativo.

  • failureCause : indica il motivo del fallimento del secondo invio tramite i codici

    • D00: Non è stato trovato nessun nuovo indirizzo per predisporre un altro tentativo di invio.

    • D01: L’indirizzo non ha superato il processo di validazione.

    • D02: L’indirizzo è già stato usato per effettuare un tentativo di invio.

(*) Per la decodifica dei codici di deliveryDetailCode all'interno dei details degli eventi di SEND_ANALOG_PROGRESS si rimanda alla pagina Decodifiche SEND_ANALOG

Last updated