API rest - Digital Archive

Introduzione

Le API per l'inserimento e la consultazione sono raggiungibili attraverso due servizi distinti. Di seguito è fornito il dettaglio di ciascun servizio.

Autenticazione

Attualmente il sistema Digital Archive ha una propria anagrafica e un proprio sistema di autenticazione attraverso token. Sono però in corso dei lavori per la migrazione verso TS Digital sia lato anagrafiche che lato sistema di autenticazione. Detto questo, attualmente le API funzionano con token generato dal sistema Digital Archive.

API Rest - Autenticazione su Digital Archive

API per la lettura

DocumentazioneLa swaggerAPI per ila lettura dei documenti conservati TODO:è metteredisponibile ilalla linkpagina adedicata prodAPI quandoRest disponibile - Lettura documenti conservati

 

Documentazione swagger per i documenti da processare TODO: mettere il link a prod quando disponibile

Le API per la consultazione dei documenti sono volte a ricercare le entità:

• pacchetto di input da processare
• pacchetto di input conservato
• pacchetto di versamento [da realizzare]
• pacchetto di archiviazione [da realizzare]
• pacchetto di distribuzione [da realizzare]

Struttura del pacchetto di input da processare

Il pacchetto di input da processare si trova in uno stato intermedio, in cui è stato acquisito dal sistema, ma di cui non è ancora stata terminata la procedura di conservazione. Le informazioni di questa entità sono un subset ridotto, che contengono le informazioni base per l'identificazione del pacchetto di input da processare.

• identifier: id del documento
• number|documentDate: metadati inseriti dall'utente in fase di versamento
• typology|typologyDescription: tipologia documentale
• rectificationInputPackageId|rectificationReason: informazioni eventuale rettifica
• receivedDate: data di ricezione del documento

Struttura del pacchetto di input conservati

Il pacchetto di input è l'entità che l'utente carica a sistema e che deve essere poi conservata. Le informazioni in essa contenute sono le seguenti:

• metadati generici: quali id del documento ed altre informazioni utili al sistema
• pdv: pacchetto di versamento a cui il pacchetto di input fa riferimento
• pda: pacchetto di archiviazione a cui il pacchetto di input fa riferimento
• file: informazioni relative al file versato
• holder: titolare al quale il documento fa riferimento
• submitter: produttore che ha versato il documento
• anno_riferimento: anno o esercizio del documento fondamentale per calcolare il tempo di conservazione
• details: metadati inseriti dall'utente in fase di versamento

API per la scrittura

Documentazione swagger per il versamento dei documenti TODO: mettere il link a prod quando disponibile

Le API per la conservazione dei documenti sono volte a processare le entità:

TODO: in teoria sono la stessa entità, le teniamo separate o fa confusione?

• pacchetto di input
• pacchetto di input rettificante

Struttura del pacchetto di input

Le informazioni contenute nell'entità che deve essere caricata a sistema sono le seguenti:

• file: informazioni relative al file da versare
• holder: titolare al quale il documento fa riferimento
• submitter: produttore che versa il documento
• details: metadati inseriti dall'utente in fase di versamento

Struttura del pacchetto di input rettificante

Le informazioni dell'entità di rettifica di un pacchetto di input sono le medesime dell'entità base, a cui vanno aggiunte le informazioni sulla rettifica:

• rectifiedInputPackageId: id documento da rettificare
• rectificationReason: motivo della rettifica

Come risposta alle azioni di versamento e rettifica di un documento si avrà un identificativo univoco relativo all'entità pacchetto di input.