Funzione: Assets -> List
Questa funzione permette la ricerca dentro al database Cespiti.
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 |
| assets_name | facoltativo | estesa | Nome del cespite che si desidera ricercare. | Stringa di testo |
Chiavi OrderBy Supportate
| OrderBy | Descrizione |
| assets_id|ASC | Ordinato per codice identificativo cespite ascendente |
| assets_id|DES | Ordinato per codice identificativo cespite 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 cespiti genera come risultati oggetti "Cespiti". Per visualizzare la struttura di un oggetto cespiti, guarda il risultato della funzione assets->get
Esempi
Esempio di ricerca di un cespite inserito su Sirio.
require("SirioService.php");
//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
//Parametri
$dataset = [
"q" => [ // "q" sta per "query"
"asset_name" => "computer"
],
"r" => 20, // "r" sta per "results" , numero risultati per pagina
"p" => 1, // "p" sta per "page", numero della pagina da visualizzare
"s" => "assets_id|DES" // "s" sta per "sort"
];
//Eseguo il comando
$result = $sirio->sendCommand("assets", "list", $dataset);
/*
{
nav: {
page: 1,
tot_pages: 1,
results: 20,
tot_results: 5,
orderBy: "assets_id|DES",
},
dataset: {
0: {
asset_id: 14,
asset_name: prova,
asset_value: 1000.00,
date_start: 2018-09-21,
tot_orders: 0.00,
amortizations: {
0: {
year: 2018,
percentage: 100.0000,
amount: 1000.0000,
iper_percentage: 0.00,
iper_amount: 0.0000
}
}
},
1: {
...
},
2: {
...
},
...
}
}
*/
Sirio - Il Gestionale è anche social!