Skip to main content

API rest - Struttura soggetti

Per ogni tipologia documentale è possibile specificare una serie di soggetti in fase di caricamento del documento. I soggetti hanno una struttura variabile in funzione della tipologia di quest'ultimo.

Tipologie di soggetti

Le possibili tipologie di soggetti sono le seguenti:

AS: ASSEGNATARIO
PF: PERSONA FISICA
PG: PERSONA GIURIDICA
PAE: PUBBLICHE AMMINISTRAZIONI ESTERE
PAI: PUBBLICHE AMMINISTRAZIONI ITALIANE
SW: SOFTWARE
Ruoli dei soggetti

I soggetti prevedono anche l'indicazione del ruolo ricoperto, i cui valori sono pilotati dal tipo del soggetto.

ASSEGNATARIO
AUTORE
DESTINATARIO
MITTENTE
OPERATORE
PRODUTTORE
RGD: RESPONSABILE GESTIONE DOCUMENTALE
RSP: RESPONSABILE SERVIZIO PROTOCOLLO
SER: SOGGETTO CHE EFFETTUA LA REGISTRAZIONE
ALTRO
Struttura dei soggetti

ASSEGNATARIO - AS

{
  "properties": {
    "ruolo": { "type": "string", "enum": ["ASSEGNATARIO"] },
    "tipo": {
      "type": "string",
      "enum": ["AS"]
    },
    "denominazione": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "denominazione_ufficio": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "cognome": {
      "type": "string",
      "maxLength": 200
    },
    "nome": {
      "type": "string",
      "maxLength": 200
    },
    "codice_fiscale": {
      "type": "string",
      "maxLength": 200
    },
    "indirizzi_digitali_riferimento": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "codice_sdi": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{6,7}$"
    }
  },
  "required": ["ruolo", "tipo", "denominazione", "denominazione_ufficio"]
}

PERSONA FISICA - PF

{
  "properties": {
    "ruolo": {
      "type": "string",
      "enum": [
        "AUTORE",
        "DESTINATARIO",
        "MITTENTE",
        "OPERATORE",
        "RGD",
        "RSP",
        "SER",
        "ALTRO"
      ]
    },
    "tipo": {
      "type": "string",
      "enum": ["PF"]
    },
    "cognome": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "nome": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "codice_fiscale": {
      "type": "string",
      "maxLength": 200
    },
    "partita_iva": {
      "type": "string",
      "maxLength": 200
    },
    "indirizzi_digitali_riferimento": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "codice_sdi": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{6,7}$"
    },
    "id_paese": { "type": "string", "pattern": "^[A-Z]{2}$" },
    "matricola": { "type": "string", "maxLength": 200 }
  },
  "required": ["ruolo", "tipo", "cognome", "nome"]
}

PERSONA GIURIDICA - PG

{
  "properties": {
    "ruolo": {
      "type": "string",
      "enum": ["AUTORE", "DESTINATARIO", "MITTENTE", "SER", "ALTRO"]
    },
    "tipo": {
      "type": "string",
      "enum": ["PG"]
    },
    "denominazione": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "denominazione_ufficio": {
      "type": "string",
      "maxLength": 200
    },
    "codice_fiscale": {
      "type": "string",
      "maxLength": 200
    },
    "partita_iva": {
      "type": "string",
      "maxLength": 200
    },
    "indirizzi_digitali_riferimento": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "codice_sdi": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{6,7}$"
    },
    "id_paese": { "type": "string", "pattern": "^[A-Z]{2}$" }
  },
  "required": ["ruolo", "tipo", "denominazione"]
}

PUBBLICHE AMMINISTRAZIONI ESTERE - PAE

{
  "properties": {
    "ruolo": {
      "type": "string",
      "enum": ["AUTORE", "DESTINATARIO", "MITTENTE", "ALTRO"]
    },
    "tipo": {
      "type": "string",
      "enum": ["PAE"]
    },
    "denominazione": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "denominazione_ufficio": {
      "type": "string",
      "maxLength": 200
    },
    "indirizzi_digitali_riferimento": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id_paese": { "type": "string", "pattern": "^[A-Z]{2}$" }
  },
  "required": ["ruolo", "tipo", "denominazione"]
}

PUBBLICHE AMMINISTRAZIONI ITALIANE - PAI