API Rest - Lettura documenti conservati

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.

Far riferimento alla documentazione relativa all'autenticazione per ottenere un token di autenticazione corretto.

/books/documentazione/page/api-rest-autenticazione-su-digital-archive

API per la lettura

La API di lettura per i documenti conservati è documentata via SWAGGER al link

/swagger-ui/index.html?url=/v3/api-docs

L'autenticazione può essere effettuata attraverso la chiamata al servizio

PRODUZIONE: [GET] https://archive-documents.teamsystem.digital/api/v3/archive/pdi/{id}

TEST: [GET] https://archive-documents.test.teamsystem.digital/api/v3/archive/pdi/{id}

Le API per la consultazione dei documenti conservati restituisce il dettaglio che descrive il versamento effettuato comprendente le informazioni di registrazione del documento, lo stato del versamento e tutti i dettagli forniti in fase di versamento.

Request header

Come le altre API esposte devono essere forniti gli header standard

API rest - Header standard per il dialogo con il servizio

Response

La struttura tecnica (body response) del servizio è documentata dallo swagger sopra indicato. Si riporta di seguito il significato delle sezioni della response.

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