Funzione: Costs -> List
Questa funzione permette la ricerca dentro al database Centro costi.
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
Null: questa funzione non adotta alcuna chiave di ricerca.Chiavi OrderBy Supportate
| OrderBy | Descrizione |
| num_order|ASC | Ordinato per ordine/posizione ascendente |
| num_order|DES | Ordinato per ordine/posizione 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 centri di costo genera come risultati oggetti "Centro costi". Per visualizzare la struttura di un oggetto Centro costi, guarda il risultato della funzione costs->get
Esempi
Esempio di ricerca di un negozio inserito su Sirio.
require("SirioService.php");
//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
//Parametri
$dataset = [
"q" => null, // "q" sta per "query"
"r" => 20, // "r" sta per "results" , numero risultati per pagina
"p" => 1, // "p" sta per "page", numero della pagina da visualizzare
"s" => "num_order|ASC" // "s" sta per "sort"
];
//Eseguo il comando
$result = $sirio->sendCommand("costs", "list", $dataset);
/*
{
nav: {
page: 1,
tot_pages: 1,
results: 10,
tot_results: 3,
orderBy: "name|DES"
},
dataset: {
0: {
cost_type_id: 3,
cost_name: Marketing,
num_order: 1,
hex_color: #3366cc
},
1: {
cost_type_id: 1
cost_name: Produzione,
num_order: 2,
hex_color: #dc3912
},
2: {
...
},
3: {
...
}
}
}
*/
Sirio - Il Gestionale è anche social!