Funzione: Shops -> List

Questa funzione permette la ricerca dentro al database negozi.

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 negozio che si desidera ricercare.	Stringa di testo

Chiavi OrderBy Supportate

OrderBy	Descrizione
name\|ASC	Ordinato per nome negozio ascendente
name\|DES	Ordinato per nome negozio discendente
shop_id\|ASC	Ordinato per codice identificativo negozio ascendente
shop_id\|DES	Ordinato per codice identificativo negozio 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 negozi genera come risultati oggetti "negozio". Per visualizzare la struttura di un oggetto negozio, guarda il risultato della funzione shops->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" => [						// "q" sta per "query"
		"name" => "negozio"
	],
	"r"	=>	20,						// "r" sta per "results" , numero risultati per pagina
	"p"	=>	1,						// "p" sta per "page", numero della pagina da visualizzare
	"s"	=>	"shop_id|DES"			// "s" sta per "sort"
];

//Eseguo il comando
$result = $sirio->sendCommand("shops", "list", $dataset);

/*
{
	nav: {
		page: 1,
		tot_pages: 1,
		results: 20,
		tot_results: 5,
		orderBy: "shop_id|DES"
	},
	dataset: {
		0: {
				shop_id: 16,
				name: Test,
				header_id: 9,
				code_prefix: TES,
				code_length: 8,
				payments_email: null,
				payments_fax: null,
				pos_nickname: null,
				pos_descriptor: null,
				pos_endpoint_ok: null,
				pos_endpoint_ko: null,
				pos_endpoint_server: null,
				pos_enabled: null,
				banks_enabled: null,
				date_created: 2018-09-21 17:49:57,
				header_name: Rossi sas,
				header_org_name: Rossi sas
		},
		1: {
			...
		},
		2: {
			...
		}
	}
}

*/

Manuale Utenti

Manuale Sviluppatori