Funzione: Cashbooks -> List
Questa funzione restituisce tutti i Registri della Prima Nota creati all'interno del database.
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 |
| name | facoltativo | estesa | Nome del Registro della Prima Nota che si desidera ricercare. | Stringa di testo. |
Chiavi OrderBy Supportate
| OrderBy | Descrizione |
| type|ASC | Ordinato per tipologia di Registro ascendente |
| type|DES | Ordinato per tipologia di Registro 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 Registri della Prima nota genera come risultati oggetti "Registri della Prima Nota". Per visualizzare la struttura di un oggetto Registri della Prima Nota, guarda il risultato della funzione cashbooks->get
Esempi
Esempio di restituzione della lista Registri della Prima Nota inseriti 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" => null // "s" sta per "sort"
];
//Eseguo il comando
$result = $sirio->sendCommand("cashbooks", "list", $dataset);
/*
{
"nav":{
"page":1,
"tot_pages":1,
"results":20,
"tot_results":7,
"orderBy":"type|ASC"
},
"dataset": {
0: {
cashbook_id: 14,
name: Prova1,
type: 1,
subtype: vantaggio,
opening: 0.00,
date_updated: null,
date_created: 2018-08-29 15:50:58,
num_entries: 2,
balance: 478.00,
date_start: 2018-09-03 00:00:00,
date_end: 2018-09-13 00:00:00
},
1: {
...
},
2: {
...
},
...
}
}
*/
Sirio - Il Gestionale è anche social!