Payload completo Digital V1
Di seguito un esempio di payload completo per il versamento di una classe documentale.
Il payload per il versamento di una qualsiasi classe documentale di Archive ha la forma del seguente esempio. Per comprendere il payload minimo, che include le sole informazioni obbligatorie, è possibile far riferimento alla documentazione
Il versamento minimo rappresenta le informazioni obbligatorie utili ad effettuare un versamento a norma, ma il payload completo consente di effettuare un versamento molto più dettagliato che consente una indicizzazione precisa dei documenti.
Tale versamento è possibile soltanto verso le API v4 e digital-v1.
Di seguito un esempio delle informazioni che devono essere inserite:
File metadata
"fileMetadata": {
"externalApplicationId": "externalApplicationId",
"hash_256": "3a6261d40bb0c8a46df3d6a03989d3f551c978937c5ef8ab1a4152c75fbc6663",
"name": "nome-file.xml"
},Identificativi intestatari documenti:
"holderUuid": "holder_id",
"submitterUuid": "submitter_id",
Informazioni di dettaglio del documento versato:
I dettagli sono simili per qualsiasi tipologia documentale. Far riferimento ai payload minimi per la compilazione delle parti obbligatorie.
La sezione "custom_metadata" in fondo al payload è in opzionale e può essere popolata con informazioni specifiche rispetto alla tipologia documentale. In particolare l'elenco dei metadati custom che possono essere versati per ogni tipologia è descritta ed esposta dalla API documentativa document-tags
"details": {
"modalita_formazione": "A",
"tipologia_documentale": "1001",
"dati_registrazione": {
"tipologia_flusso": "U",
"tipo_registro": "NESSUNO",
"data": "2020-01-01T00:00:00.000Z",
"numero": "08399238740"
},
"chiave_descrittiva": {
"oggetto": "oggetto",
"parole_chiave": [
"parola_chiave_1",
"parola_chiave_2",
"parola_chiave_3"
]
},
"soggetti": [
{
"ruolo": "ASSEGNATARIO",
"tipo": "AS",
"denominazione": "nominativo",
"denominazione_ufficio": "denominazione_ufficio",
"codice_fiscale": "AAAAAA00A00A000A",
"indirizzi_digitali_riferimento": ["pec@mail.it"],
"codice_sdi": "abc0123"
},
{
"ruolo": "SER",
"tipo": "PF",
"cognome": "cognome",
"nome": "nome",
"matricola": "matricola",
"codice_fiscale": "AAAAAA00A00A000A",
"partita_iva": "00000000000",
"indirizzi_digitali_riferimento": ["pec@mail.it"],
"codice_sdi": "abc0123",
"id_paese": "IT"
}
],
"classificazione": {
"indice": "indice",
"descrizione": "descrizione",
"piano": "piano"
},
"riservato": true,
"verifica": {
"firmato_digitalmente": true,
"sigillato_elettronicamente": true,
"marcatura_temporale": true,
"conformita_copie_immagine": true
},
"id_agg": [
{
"tipo_aggregazione": "FASCICOLO",
"id_aggregazione": "id_aggregazione"
}
],
"identificativo_documento_primario": {
"impronta": "N/w8pua3nHwlVGA7CGE/0b505PwgOdeyvmCm7/tZbOk=",
"algoritmo": "algoritmo",
"identificativo": "identificativo"
},
"versione": "1",
"tracciature_modifiche": {
"tipo": "ANNULLAMENTO",
"soggetto_autore": {
"nome": "nome",
"cognome": "cognome",
"codice_fiscale": "AAAAAA84D07F712P",
"indirizzi_digitali_riferimento": [
"mail_1@mail.com",
"mail_2@mail.com"
]
},
"data": "2020-01-01T00:00:00.000Z",
"id_versione_precedente": {
"impronta": "N/w8pua3nHwlVGA7CGE/0b505PwgOdeyvmCm7/tZbOk=",
"algoritmo": "algoritmo",
"identificativo": "identificativo"
}
},
"allegati": {
"numero_allegati": 0
},
"anno_riferimento": 2019,
"note": "note",
"custom_metadata": {
"sezionale": "sezionale",
"pec_destinatario": "pec_destinatario",
}
}