API documentativa - Document tags

Archive espone le informazioni relative alle tipologie documentali supportate attraverso un servizio, consultabile via API / Rest. Tale servizio può essere consultato all'indirizzo

https://cct-archive-documents-tags.test.teamsystem.digital/swagger-ui/index.html?url=/v3/api-docs#/

Le varie API esposte consentono di comprendere ed estrapolare l'elenco delle tipologie supportate dal servizio e, richiedendo una specifica tipologia è possibile estrarre le seguenti informazioni:

Informazioni generali

Codice tipologia, descrizione e formati file abilitati e accettati per la particolare tipologia

"documentTypeCode": "2079",
"documentTypeDescription": "Informative consenso privacy",
"enabledExtensions": [
  "pdf",
  "tif",
  "tiff",
  "jpg",
  "jpeg"
],

Elenco tag:

• Specializzazione dei campi di dettaglio con tipologia e percorso nei details. Informazioni sulla obbligatorietà delle informazioni.
• Elenco dei campi custom che possono essere inseriti nella sezione "custom_metadata"

  "tags": [
    {
      "code": "data_registrazione",
      "serviceCardLabel": "Data di registrazione",
      "path": "details.datiRegistrazione.data",
      "fullPath": "details.dati_registrazione.data",
      "type": "date",
      "wcfPath": "DataConsenso",
      "wcfOnly": false,
      "required": false
    },
    {
      "code": "numero_documento",
      "serviceCardLabel": "Numero documento",
      "path": "details.datiRegistrazione.numero",
      "fullPath": "details.dati_registrazione.numero",
      "wcfOnly": false,
      "required": false
    },
    {
      "code": "tipo",
      "serviceCardLabel": "Tipo",
      "description": "Campo descrittivo libero",
      "path": "details.customMetadata",
      "fullPath": "details.custom_metadata.tipo",
      "type": "string",
      "wcfPath": "Tipo",
      "wcfOnly": false,
      "placeholder": "Inserisci il tipo di documento",
      "required": false,
      "rules": {
        "maxLength": 200
      },
      "errors": {
        "maxLength": "La lunghezza massima è di 200 caratteri"
      },
      "layoutSettings": {
        "order": 0,
        "gridParameter": "1 / span 2"
      }
    },
    {
      "code": "periodo_imposta",
      "serviceCardLabel": "Periodo di Imposta",
      "path": "annoRiferimento",
      "fullPath": "anno_riferimento",
      "wcfPath": "PeriodoRiferimentoAnno",
      "wcfOnly": true,
      "required": false
    },
    {
      "code": "cognome_nome_interessato",
      "serviceCardLabel": "Cognome nome interessato",
      "path": "details.soggetti.destinatario",
      "fullPath": "details.soggetti.destinatario.cognome",
      "wcfPath": "CognomeNomeInteressato",
      "wcfOnly": true,
      "required": false
    },
    {
      "code": "codice_fiscale_interessato",
      "serviceCardLabel": "Codice fiscale interessato",
      "path": "details.soggetti.destinatario",
      "fullPath": "details.soggetti.destinatario.codiceFiscale",
      "wcfPath": "CodiceFiscaleInteressato",
      "wcfOnly": true,
      "required": false
    },
    {
      "code": "idaggregazione",
      "serviceCardLabel": "Id fascicolo nel sistema amministrazione",
      "path": "details.idagg",
      "fullPath": "details.idagg.identificativoAggregazione",
      "wcfPath": "IdentificativoInternoFascicolo",
      "wcfOnly": true,
      "required": false
    },
    {
      "code": "identificativo",
      "serviceCardLabel": "Identificativo Sistema Amministrazione",
      "path": "details.identificativoDocumentoPrimario",
      "fullPath": "details.identificativoDocumentoPrimario.identificativo",
      "wcfPath": "IdentificativoInternoDocumento",
      "wcfOnly": true,
      "required": false
    },
    {
      "code": "codice_identificativo",
      "serviceCardLabel": "Codice identificativo",
      "path": "details.classificazione",
      "fullPath": "details.classificazione.indice",
      "wcfPath": "CodiceIdentificativo",
      "wcfOnly": true,
      "required": false
    }
  ]

Default pre-impostati.

Se non vengono passate queste informazioni i relativi campi vengono impostati nel versamento come qui riportato.

"defaults": {
  "modalita_formazione": "A",
  "tipologia_flusso": "E",
  "tipologia_destinatario": "PF",
  "tipologia_mittente": "PG",
  "tipologia_autore": "PAI",
  "tipologia_altro": "PF"
}

nel caso in cui si debba valorizzare un soggetto con il ruolo indicato in uno dei default "tipologia*, è possibile far riferimento a questi default per avere un suggerimento su quale tipologia di soggetto può essere utilizzata. 

La tipologia del soggetto è da scegliere a discrezione di chi effettua il versamento. In questi campi però è stata esposta la tipologia che può essere utilizzata anche in relazione ai campi esposti nell'elenco dei tags.

Ad esempio se nei tags è stato esposto un campo definito come:

{
      "code": "cognome_nome_interessato",
      "serviceCardLabel": "Cognome nome interessato",
      "path": "details.soggetti.destinatario",
      "fullPath": "details.soggetti.destinatario.cognome",
      "wcfPath": "CognomeNomeInteressato",
      "wcfOnly": true,
      "required": false
    }

dal fullpath si può evincere come il tag indicato fa riferimento nel documento da predisporre per il versamento all'array di soggetti disponibile in details.soggetti[] in cui introdurre un oggetto con ruolo destinatario sui cui dovrà essere valorizzato l'attributo cognome.

Il soggetto dovrà essere creato di una certa tipologia e la sua struttura dovrà essere una di quelle accettate dall'AGID. Far riferimento alla documentazione per maggiori dettagli. 

Il default suggerisce quale tipologia utilizzare e che avrà a disposizione gli attributi corretti. Nell'esempio sopra la tipologia_destinatario avrà valore "PF", ossia persona fisica.

"default:" {
  ... 
  "tipologia_destinatario": "PF",
  ...
}

 

 

Soggetti

I vincoli sui soggetti indicano quali soggetti devono essere inseriti e quali soggetti verranno automaticamente compilati nel caso in cui non vengano inclusi nel versamento. 

I default utilizzati per il versamento sono disponibili sulla scheda di servizio.

"subjects": [
  {
    "role": "AUTORE",
    "minItems": 0,
    "maxItems": null
  },
  {
    "role": "SER",
    "minItems": 0,
    "maxItems": 1
  }
],
"subjectsToAutofill": [
  "AUTORE",
  "SER"
]