API rest - Versamento nuovi documenti da conservare
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
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.