Funzione: Customers -> List
Questa funzione permette la ricerca dentro al database clienti.
Parametri
| Campo | Obbligatorio | Descrizione | Valori Ammessi |
| query | facoltativo |
Parametri di ricerca
Oggetto JSON tramite il quale è possibile specificare le chiavi di ricerca: (chiave = valore).
Vedere sezione oggetto query più sotto per maggiori spiegazioni |
Oggetto JSON |
| results | facoltativo | Numero dei risultati da visualizzare per pagina. |
Numero. Predefinito: 10 risultati |
| page | facoltativo |
Pagina da visualizzare
Il sistema crea un numero di pagine sfogliabili in base al numero di risultati della ricerca
e a quanti risultati si desidera vedere per pagina
results
|
Numero. Predefinito: pagina 1 |
| orderBy | facoltativo |
Ordine di visualizzazione dei risultati
Vedere sezione chiavi OrderBy supportate più sotto per maggiori spiegazioni
|
Stringa di testo contenente una chiave OrderBy supportata |
Oggetto Query
| Campo | Obbligatorio | Tipologia di ricerca | Descrizione | Valori Ammessi |
| general | facoltativo | estesa | Nome, email, CF, P.IVA dell'anagrafica cliente che si desidera ricercare. | Stringa di testo |
| name | facoltativo | estesa | Nome dell'anagrafica cliente che si desidera ricercare. | Stringa di testo |
| facoltativo | estesa | Indirizzo email dell'anagrafica cliente che si desidera ricercare. | Stringa di testo | |
| tel | facoltativo | estesa | Telefono/cellulare dell'anagrafica cliente che si desidera ricercare. | Stringa di testo |
| taxcode | facoltativo | estesa | CF/P.IVA dell'anagrafica cliente che si desidera ricercare. | Stringa di testo |
| balance | facoltativo | estesa | Saldo | Codice numerico |
| errors | facoltativo | estesa | Anagrafiche | Codice numerico |
Chiavi OrderBy Supportate
| OrderBy | Descrizione |
| contact_name|ASC | Ordinato per nome cliente ascendente |
| contact_name|DES | Ordinato per nome cliente discendente |
| balance|ASC | Ordinato per saldo ascendente |
| balance|DES | Ordinato per saldo discendente |
| date_created|ASC | Ordinato per data di creazione del cliente ascendente |
| date_created|DES | Ordinato per data di creazione del cliente discendente |
Risultato
| Campo | Obbligatorio | Descrizione | Valori Ammessi |
| nav | obbligatorio | Oggetto contenente i dati di navigazione. | Oggetto JSON |
| nav.page | obbligatorio | Numero di pagina visualizzato | Numero |
| nav.tot_pages | obbligatorio | Numero di pagine totali | Numero |
| nav.results | obbligatorio | Numero di risultati per pagina visualizzati | Numero |
| nav.tot_results | obbligatorio | Numero di risultato totali della ricerca | Numero |
| nav.orderBy | obbligatorio | Ordine di ricerca realmente applicato | Stringa di testo. |
| dataset | obbligatorio | Oggetto contenente i risultati | Oggetto JSON |
| dataset[n] | facoltativo | Oggetto contenente il risultato n | Oggetto JSON |
La ricerca sui clienti genera come risultati oggetti "Anagrafiche Clienti". Per visualizzare la struttura di un oggetto "Anagrafiche Clienti", guarda il risultato della funzione suppliers->get
Esempi
Esempio di ricerca di un fornitore inserito su Sirio.
require("SirioService.php");
//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
//Parametri
$dataset = [
"q" => "ente", // "q" sta per "query"
"r" => 10, // "r" sta per "results" , numero risultati per pagina
"p" => 1, // "p" sta per "page", numero della pagina da visualizzare
"s" => "name|DES" // "s" sta per "sort"
];
//Eseguo il comando
$result = $sirio->sendCommand("customers", "list", $dataset);
/*
{
nav: {
page: 1,
tot_pages: 1,
results: 10,
tot_results: 3,
orderBy: "name|DES",
},
dataset: {
customer_id: 283,
contact_name: "COMUNE DI LODI",
entity_code: "51abaee564adeb4d625095449f032fb2",
entity_type: 200,
entity_nationalitycode: "IT",
org_name: "COMUNE DI LODI",
org_vat_code: "03116800156",
org_tax_code: "84507570152",
name: "",
surname: "",
tax_code: "",
address_street: "Piazza Broletto",
address_street_number: 1,
address_city: "Lodi",
address_province: "LO",
address_postalcode: "26900",
address_countrycode: "IT",
contact_tel: "",
contact_fax: "",
contact_mobile: "",
contact_email: "ente@ente.it",
strict_error: null,
eInvoice: 1
eInvoice_list_id: 1,
eInvoice_date_start: 2015-03-31,
balance: 0.00,
hdymu: 0,
date_created: 2018-09-24 10:35:17,
date_updated: 2018-09-24 10:36:07,
contact_tax_code: "03116800156"
},
{
...
},
{
...
}
}
*/
Sirio - Il Gestionale è anche social!