Changelog API di Interoperabilità RENTRi

In questo file vengono riportate e mantenute aggiornate tutte le modifiche apportate al progetto API di Interoperabilità RENTRi. Il formato del changelog è basato sui principi guida di Keep a Changelog.

[1.0.20230120] - 2023-01-20

Aggiunto

• Nuovo endpoint POST /api/v1.2/formulari/{numeroFIR}/rollback per eliminare tutte le firme e tutti i dati aggiunti al formulario successivi allo stato di "FirmaProduttoreTrasportatorePartenza", permettendo così di apporre modifiche ai dati iniziali di partenza senza dover annullare il FIR; successivamente a questa operazione sarà necessaria la riapposizione delle firme eliminate e il reinvio e la firma delle eventuali ulteriori informazioni di trasporto per trasporti successivi al primo, e delle eventuali annotazioni e/o allegati precedentemente apposti.

[1.0.20220712] - 2022-07-12

Aggiunto

• Nuovo endpoint POST /api/v1.2/formulari/{numeroFIR}/quantita per impostare i dati relativi alle quantità previsti per l'emissione di un nuovo formulario.
• Nuove proprietà nell'oggetto usato come filtro nella funzione di elenco formulari.
• Nuove proprietà nell'oggetto di cui è composto l'array di risposta della funzione di elenco formulari.

Modificato

• Il modello per l'invio dei dati del nuovo formulario non ha più fra i dati richiesti la proprietà "quantitaRifiuto", la cui struttura dati potrà essere inviata succesivamente alla creazione del formulario con l'apposito endpoint.
• L'enumerativo EnumStatoFormulario prevede due nuovi stati: "InserimentoQuantita" (il formulario necessità dell'inserimento dei dati quantità, attraverso un nuovo endpoint) e "InserimentoQuantitaTrasportoPartenza" (il formulario necessita dell'inserimento sia dei dati quantità che di quelli di inizio trasporto).

[1.0.20220506] - 2022-05-06

Aggiunto

• Nuovi endpoint dell'API Registri v1.4 per la gestione asincrona dei movimenti tramite callback (RPC PUSH secondo le linee guida AgID), disponibili tramite la base URL /api/v1.4/registri/async-push.
• Nuovo endpoint POST /api/v1.4/registri/async-push/{identificativoRegistro}/movimenti per inviare una richiesta di caricamento di movimenti.
• Nuovo endpoint POST /api/v1.4/registri/async-push/{identificativoRegistro}/movimenti-annullamenti per inviare una richiesta di annullamento di movimenti.
• Nuovo endpoint POST /api/v1.4/registri/async-push/{identificativoRegistro}/movimenti-quantita-verificate per inviare una richiesta di aggiornamento sulle quantità verificate.
• Nuovo endpoint POST /api/v1.4/registri/async-push/{identificativoRegistro}/movimenti per inviare una richiesta di rettifica di movimenti.

Modificato

• I metodi HTTP di tutti gli endpoint di invio richieste asincrone (vedi v.1.0.20220422) sono stati adeguati da PUT a POST, come da linee guida AgID.

[1.0.20220422] - 2022-04-22

Aggiunto

• Nuova API Registri v1.4 con nuovi endpoint per la gestione asincrona dei movimenti (RPC PULL secondo le linee guida AgID), disponibili tramite la base URL /api/v1.4/registri.
• Nuovo endpoint POST /api/v1.4/registri/async/{identificativoRegistro}/movimenti per inviare una richiesta di caricamento di movimenti.
• Nuovo endpoint PUT /api/v1.4/registri/async/{identificativoRegistro}/movimenti-annullamenti per inviare una richiesta di annullamento di movimenti.
• Nuovo endpoint PUT /api/v1.4/registri/async/{identificativoRegistro}/movimenti-quantita-verificate per inviare una richiesta di aggiornamento sulle quantità verificate.
• Nuovo endpoint PUT /api/v1.4/registri/async/{identificativoRegistro}/movimenti per inviare una richiesta di rettifica di movimenti.
• Nuovo endpoint GET /api/v1.4/registri/async/movimenti/{idRichiesta}/status per richiedere lo stato di elaborazione di una richiesta.
• Nuovo endpoint GET /api/v1.4/registri/async/movimenti/{idRichiesta}/result per richiedere l'esito di elaborazione di una richiesta.

[1.0.20220323] - 2022-03-23

Aggiunto

• Nuova API Registri v1.3 i cui endpoint sono disponibili tramite la base URL /api/v1.3/registri.
• Nuovo endpoint GET /api/v1.3/registri/{identificativoRegistro}/movimenti per ottenere l'elenco dei movimenti relativi ad un Registro. A differenza della v1.2, contiene il parametro aggiuntivo dataAl per specificare un preciso momento di validità.
• Nuovo endpoint GET /api/v1.3/registri/{identificativoRegistro}/movimenti/count per ottenere il conteggio dei movimenti di un registro che corrispondono ai criteri specificati. A differenza della v1.2, contiene il parametro aggiuntivo dataAl per specificare un preciso momento di validità.
• Nuovo endpoint GET /api/v1.3/registri/{identificativoRegistro}/movimento-dettaglio/{anno}/{progressivo} per ottenere il dettaglio di un movimento tramite Anno/Progressivo. A differenza della v1.2, non restituisce le variazioni del movimento e contiene il parametro aggiuntivo dataAl per specificare un preciso momento di validità.
• Nuovo endpoint GET /api/v1.3/registri/{identificativoRegistro}/movimento-dettaglio/{identificativoMovimento} per ottenere il dettaglio di un movimento tramite IdentificativoMovimento. A differenza della v1.2, non restituisce le variazioni del movimento e contiene il parametro aggiuntivo dataAl per specificare un preciso momento di validità.
• Nuovo endpoint GET /api/v1.3/registri/{identificativoRegistro}/movimento-history/{anno}/{progressivo} per ottenere la storia di un movimento (tutte le sue variazioni) tramite Anno/Progressivo.
• Nuovo endpoint GET /api/v1.3/registri/{identificativoRegistro}/movimento-history/{identificativoMovimento} per ottenere la storia di un movimento (tutte le sue variazioni) tramite IdentificativoMovimento.
• Nuovo endpoint per le Associazioni di Categoria POST /api/v1.3/registri/associazioni-categoria/registri-associati/{identificativoStruttura} per creare un nuovo registro associato ad un sito gestito da un'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria PUT /api/v1.3/registri/associazioni-categoria/registri-associati/{identificativoRegistro} per modificare i dati di un registro gestito da un'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria DELETE /api/v1.3/registri/associazioni-categoria/registri-associati/{identificativoRegistro} per eliminare un registro gestito da un'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria PUT /api/v1.3/registri/associazioni-categoria/registri-associati/{identificativoRegistro}/chiudi per chiudere un registro gestito da un'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria GET /api/v1.3/soggetti/associazioni-categoria/soggetti-associati/{identificativoAssociazione} per ottenere l'elenco di soggetti e siti che hanno delegato l'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria POST /api/v1.3/soggetti/associazioni-categoria/soggetti-associati/{identificativoAssociazione} per caricare una richiesta di inserimento deleghe per un'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria DELETE /api/v1.3/soggetti/associazioni-categoria/soggetti-associati/{identificativoAssociazione} per rimuovere l'assegnazione di un sito ad un'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria GET /api/v1.3/soggetti/associazioni-categoria/soggetti-associati/{idRichiesta}/status per ottenere lo stato dell'elaborazione di una richiesta di inserimento deleghe di un'Associazione di Categoria.
• Nuovo endpoint per le Associazioni di Categoria GET /api/v1.3/soggetti/associazioni-categoria/soggetti-associati/{idRichiesta}/result per ottenere l'esito dell'elaborazione di una richiesta di inserimento ddeleghe di un'Associazione di Categoria.

Modificato

• Tramite l'endpoint PUT /api/v1.2/registri/{identificativoRegistro}/movimenti per la rettifica di uno o più movimenti, è ora possibile rettificare anche movimenti che erano stati precedentemente annullati.

[1.0.20220118] - 2022-01-18

Aggiunto

• Nuova API (api/v1.1/formulari) per la creazione di un nuovo formulario: rispetto al metodo analogo della versione precedente restituisce un oggetto JSON che riporta, oltre al numero FIR del formulario appena creato, un array di eventuali avvisi riguardanti criticità attribuibili al modello inviato come input al metodo che non impediscono l'esito positivo della transazione. In particolare il nuovo endpoint, quando invocato in ambiente DEMO, accetta che si indichino come trasportatori anche soggetti non iscritti all'Albo Nazione Gestori Ambientali, in modo da permettere i test necessari con anagrafiche arbitrarie, riportando tra gli avvisi l'eventuale non conformità dei soggetti trasportatori indicati.

[1.0.20211222] - 2021-12-22

Aggiunto

• Nuova API (api/v1.0/formulari) per integrare l'interoperabilità dei formulari. Tramite l'API /formulari è possibile creare e annullare un FIR secondo lo schema dell'XFIR. Inoltre sono disponibili gli endpoint per il download dei FIR in formato PDF e XFIR.
• Nuova API Registri v1.2 i cui endpoint sono disponibili tramite la base URL /api/v1.2/registri.
• Nuovi endpoint PUT /api/v1.2/registri/{identificativoRegistro}/movimenti-annullamenti per l'annullamento di una lista di movimenti identificabili tramite Anno/Progressivo oppure IdentificativoMovimento.

Modificato

• Modificati i parametri di paginazione per l'endpoint GET /api/v1.2/registri/{identificativoRegistro}/movimenti : Paging-Page, Paging-PageSize
• Modificato il parametro dell'idChain per gli endpoint POST ,PUT /api/v1.2/registri/{identificativoRegistro}/movimenti e PUT /api/v1.2/registri/{identificativoRegistro}/movimenti-quantita-verificate : Rentri-IdChain

[1.0.20211115] - 2021-11-15

Aggiunto

• Nuovo endpoint GET /api/v1.1/registri/{identificativoRegistro}/movimento-dettaglio/{anno}/{progressivo} per ottenere il dettaglio di un movimento e tutte le sue rettifiche tramite Anno/Progressivo.
• Nuovo endpoint GET /api/v1.1/registri/{identificativoRegistro}/movimento-dettaglio/{identificativoMovimento} per ottenere il dettaglio di un movimento e tutte le sue rettifiche tramite IdentificativoMovimento.
• Nuovo endpoint GET /api/v1.1/registri/{identificativoRegistro}/movimenti/count per ottenere il conteggio dei movimenti di un registro che corrispondono ai criteri specificati.

Modificato

• API Registri v1.1: nel modello MovimentoAssociato è stato aggiunto il campo AssociazioneDiretta di tipo bool che indica se il movimento associato è in relazione diretta (true) con il movimento padre, ovvero se si tratta di un movimento associato fornito in fase di caricamento/invio dei dati, oppure (false) se si tratta di una relazione indiretta, derivata dal sistema.

[1.0.20211108] - 2021-11-08

Aggiunto

• Verifica dell'intervallo di valori nei campi Quantita e QuantitaVerificata.
• Nuovo codice di errore sys.outOfRange utilizzato nel caso di valori esterni ad un intervallo prestabilito.

Modificato

• Modelli CreateMovimento e CreateMovimentoRettifica: aggiornamento della formattazione nei campi di tipo DateTime. I campi DataRegistrazione e DataEmissioneFir ora sono solamente di tipo data, mentre i campi DataTrasportoFir e DataVerificaQuantita rimangono di tipo data/ora.

[1.0.20211025] - 2021-10-25

Aggiunto

• Nuovi valori per i codici dei tipi di operazione: CE, CR, CT.
• Gestione dei movimenti non registrati (riferimenti mancanti) che possono essere inviati come movimenti associati.
• Nuova API per la firma remota con certificato di dominio RENTRI (/api/v1.0/sign).
• Nuova API Registri v1.1 i cui endpoint sono disponibili tramite la base URL /api/v1.1/registri.
• Modello Movimento v1.1: il campo MovimentiAssociati[] sostituisce i sostituiti i campi MovimentiCarico[] e MovimentiScarico[] della v1.0 e contiene tutte le informazioni sui movimenti collegati.
• Modello MovimentoAssociato v1.1, rispetto alla v1.0 è stato aggiunto il campo CodiceTipoOperazione.

Rimosso

• Rimossa la RegEx per la validazione del campo NumeroFIR.

[1.0.20210914] - 2021-09-14

Aggiunto

• Verifica se i movimenti indicati nei modelli CreateMovimentoRettifica e UpdateQuantitaVerificata sono già stati annullati.

Corretto

• Bugfix: corretta la RegEx per la validazione del campo NumeroFIR, che ora valida sia il formato FIR, sia il nuovo formato ViViFIR.

[1.0.20210812.1] - 2021-08-12

Aggiunto

• Nuovo endpoint PUT /api/v1.0/registri/{identificativoRegistro}/movimenti-quantita-verificate per la comunicazione delle informazioni sulla quantità verificata a destino relativa ad un insieme di movimenti.
• Modello Movimento: aggiunti nuovi campi DataInizioValidita e DataFineValidita, relativi alle rettifiche.

Corretto

• Bugfix: corretta la RegEx per la validazione dei campi Quantita e QuantitaVerificata in tutti i modelli dove veniva utilizzata.
• Bugfix: corretto un problema di mapping dei Carichi/Scarichi nel modello Movimento.
• Bugfix: corretto un problema per il quale era possibile che a volte l'HTTP Status Code ricevuto a seguito di una chiamata POST/PUT fosse di tipo 20x, anche in caso di errori.

[1.0.20210731.1] - 2021-07-30

Aggiunto

• Nuovo endpoint DELETE /api/v1.0/registri/{identificativoRegistro}/movimenti/{anno}/{progressivo} per l'annullamento di un movimento tramite Anno/Progressivo.
• Modello CreateMovimento: nuovo campo Anno, ora abbinato al campo Progressivo, utilizzati per l'identificazione univoca di un movimento (lato impresa).
• Modello CreateMovimento: nuovo modello ProgressivoMovimento per l'identificazione dei MovimentiAssociati che contiene i campi Anno e Progressivo, che sostituisce il precedente campo int[].
• Modello CreateMovimento: aggiunto nuovo campo DataVerificaQuantita.
• Modello Movimento: aggiunto nuovo campo DataVerificaQuantita.
• Modello Movimento: aggiunto nuovo campo DataAnnullamento.
• Modello Movimento: aggiunto nuovo campo DataUltimaRettifica.

Modificato

• Modello CreateMovimentoRettifica: aggiunti tutti i campi necessari alla comunicazione di una rettifica completa.
• Modello Movimento: modificata la cardinalità del campo MovimentoScarico, che ora è 1-N (tipo MovimentoAssociato[]).
• Per l'identificazione dei movimenti da rettificare è possibile utilizzare l'Identificativo generato dal sistema, oppure la coppia Anno/Progressivo.
• Il modello MovimentoCollegato è stato rinominato in MovimentoAssociato.
• Modello MovimentoAssociato: aggiunto nuovo campo Anno.

Rimosso

• Modello CreateMovimentoRettifica: rimossa la differenziazione delle rettifiche in base al tipo; il campo TipoRettifica è stato rimosso.