Universal Web Platform · Comuni

Comuni: l'archivio dei comuni con CAP, provincia e codici

Comuni: l'archivio dei comuni con CAP, provincia e codici. Nel web service è il tipo COMUNI (valore 37 di DataType); gli oggetti sono della classe Comuni e viaggiano nella lista ObjectListComuni della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoCOMUNI = 37
ClasseComuni
Lista nella richiesta e nella rispostaObjectListComuni
Tabella letta da QUERYComuni — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveID — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassID
Chiave per le conferme di ricezioneID — come si usa
Controlli prima del salvataggioID: «Identificativo non specificato»
Citta: «Descrizione non specificato»

I campi di Comuni

La colonna Obbligatorio riporta i campi chiave e quelli controllati dal server prima di salvare; Predefinito è il valore che il campo assume se non lo invii; Colonna è il nome del campo nel database, da usare nei filtri di lettura.

CampoTipoObbligatorioPredefinitoColonnaA cosa serve
IDInteroChiave, sì0idNumero identificativo interno. Se manca il server risponde «Identificativo non specificato».
CodiceCittaTesto—vuotocodcittaCodice città.
CittaTestoSìvuotocittaCittà. Se manca il server risponde «Descrizione non specificato».
ProvinciaTesto—vuotoprovSigla della provincia.
CAPTesto—vuotocapCodice di avviamento postale.
CodRegioneTesto—vuotocodregioneCodice regione.
CapoluogoProvinciaVero/falso—falsecapoprovCapoluogo provincia.
CapoluogoRegioneVero/falso—falsecaporegioneCapoluogo regione.
ElencoCAPTesto—vuotoelencocapElenco CAP.
ZonaItaliaTesto—vuotozonaitaliaZona italia.
PopolazioneIntero lungo—0popolazionePopolazione.
NazionePerCodiceFiscaleVero/falso—falsenazionepercodfiscNazione per codice fiscale.

Esempi

Inserimento o aggiornamento di un record (valori di esempio). Ricorda che INSERTORMODIFY riscrive tutti i campi: quelli che non invii tornano al valore predefinito, quindi per modificare un record esistente invia il record completo.

JSON · INSERTORMODIFY
{
  "DataOperation": 0,
  "TypeObject": 37,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListComuni": [
    {
      "ID": 1,
      "CodiceCitta": "COD001",
      "Citta": "ESEMPIO",
      "Provincia": "ESEMPIO",
      "CAP": "ESEMPIO",
      "CodRegione": "ESEMPIO"
    }
  ]
}

Lettura con filtro: fino a 100 record, ignorando le conferme di ricezione.

JSON · QUERY
{
  "DataOperation": 3,
  "TypeObject": 37,
  "GuidPC": "gestionale-01",
  "SQLFilter": "Comuni.id = 'COD001'",
  "QueryParameter": {
    "IgnoreImportRecord": true,
    "StartingRecord": 1,
    "LimitRecord": 100
  }
}

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 37,
  "GuidPC": "gestionale-01",
  "ObjectListComuni": [
    {
      "ID": 1
    }
  ]
}

Le regole su formati, date, numeri e compressione sono in formato e trasporto; esempi completi in esempi di codice.