API rest - Versamento nuovi documenti da conservare

In costruzione, alcuni contenuti potrebbero essere incompleti o da revisionare

Autenticazione

L'autenticazione valida per i servizi di versamento deve essere effettuata secondo specifiche indicate nella documentazione associata, disponibile al link API Rest - Autenticazione su Digital Archive

API per la scrittura

DocumentazionePer swagger pereffettuare il versamento deidi documenti TODO:da mettereconservare ilè linkpossibile autilizzare prodi quandoservizi disponibileesposti dalla seguente documentazione

Documentazione swagger di test: https://digital-archive-upload.test.teamsystem.digital/swagger/static/index.html

Documentazione swagger di produzione: https://digital-archive-upload.teamsystem.digital/swagger/static/index.html

Le APIapi perriportate lanella conservazionedocumentazione deiconsentono documentiil sonoversamento volte a processare ledelle 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

Per il dettaglio delle informazioni che possono essere inserite nell'entità è possibile far riferimento alla scheda di servizio o agli esempi completi o minimi documentati.

Struttura del pacchetto di input rettificante

Le informazioni dell'entità di rettifica di un pacchetto di input sono le medesime dell'entità base,base del pacchetto di input, 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.

Versamento e rettifica dei documenti

Il versamento dei nuovi documenti può essere effettuato sul servizio

POST /digital/v1/input-package

La rettifica dei documenti può essere effettuata sul servizio

POST /digital/v1/rectify-input-package