Marchi: i marchi degli articoli, con logo, sito e ordinamento. Nel web service è il tipo BRAND (valore 0 di DataType); gli oggetti sono della classe Brand e viaggiano nella lista ObjectListBrand della richiesta e della risposta.
Scheda tecnica
| Voce | Valore |
|---|
| Tipo di dato | BRAND = 0 |
| Classe | Brand |
| Lista nella richiesta e nella risposta | ObjectListBrand |
| Tabella letta da QUERY | brand — è il nome da usare davanti alle colonne in SQLFilter |
| Operazioni ammesse | QUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2) |
| Campi chiave | Codice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea |
| Chiave per cancellare con DeletingClass | Codice |
| Chiave per le conferme di ricezione | Codice — come si usa |
| Controlli prima del salvataggio | Codice: «Codice non specificato»
Descrizione: «Descrizione non specificato» |
I campi di Brand
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.
| Campo | Tipo | Obbligatorio | Predefinito | Colonna | A cosa serve |
|---|
Codice | Testo | Chiave, sì | vuoto | codice | Codice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato». |
Descrizione | Testo | Sì | vuoto | descrizione | Descrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato». |
Logo | ImageTrasmission | — | oggetto vuoto | — | Logo, come file in Base64. |
DescrizioneDettagliata | Testo | — | vuoto | descrizionedett | Descrizione estesa, anche in HTML. |
SitoWEB | Testo | — | vuoto | sitoweb | Indirizzo del sito web. |
Obsoleto | Vero/falso | — | false | obsoleto | Vero se il record non è più in uso: resta in archivio ma non viene proposto. |
Ordinamento | Intero | — | 0 | ordinamento | Posizione nell'ordinamento: i valori più bassi vengono prima. |
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": 0,
"GuidPC": "gestionale-01",
"AllInsert": false,
"ObjectListBrand": [
{
"Codice": "COD001",
"Descrizione": "Descrizione di esempio",
"DescrizioneDettagliata": "Descrizione di esempio",
"SitoWEB": "ESEMPIO",
"Obsoleto": false,
"Ordinamento": 1
}
]
}
Lettura con filtro: fino a 100 record, ignorando le conferme di ricezione.
JSON · QUERY{
"DataOperation": 3,
"TypeObject": 0,
"GuidPC": "gestionale-01",
"SQLFilter": "brand.codice = 'COD001'",
"QueryParameter": {
"IgnoreImportRecord": true,
"StartingRecord": 1,
"LimitRecord": 100
}
}
Cancellazione: bastano i campi chiave.
JSON · DELETE{
"DataOperation": 1,
"TypeObject": 0,
"GuidPC": "gestionale-01",
"ObjectListBrand": [
{
"Codice": "COD001"
}
]
}
Le regole su formati, date, numeri e compressione sono in formato e trasporto; esempi completi in esempi di codice.