...
Di seguito sono elencate le entità per le quali è disponibile una chiamata GET:
| Entità | Route di base | Azione | Parametri opzionali | Dati restituiti |
|---|---|---|---|---|
| Badge | badge | index | ||
| Contatti | contact | index | page size | |
| Eventi | event | index | ||
| Eventi | event | get-all-events | Ritorna tutti gli eventi non cancellati dell'utente attuale | |
| Liste | list | index | ||
| Luoghi | hall | index | ||
| Mailing | mailing | index | ||
| Partecipanti | participant | index | page size | |
| Postazioni | location | index | ||
| Timbratori | timestamper | index |
...
Parametri delle richieste GET
Le richieste GET devono specificare il formato di risposta desiderato. Il parametro deve avere indice "type" e deve essere passato in GET. Per ora è disponibile solo il formato json.
SOLO le azioni "index" permettono di utilizzare i filtri e le relazioni (spiegate di seguito).
Filtri per azioni index
Il filtro è un parametro GET che specifica il campo su cui applicare il filtro e il suo valore.
...
ContactSearch[name]=paolo&ContactSearch[surname]=rossi ritorna solo i contatti con nome "paolo" e cognome "rossi".
Relazioni per azioni index
È possibile specificare le relazioni da ottenere insieme al modello richiesto. Il parametro deve avere indice "relations" e deve essere passato in GET.
...
relations[]=customer&relations[]=contacts ritorna il modello cliente e i modelli contatti dell'entità ricercata.
Parametri opzionali
Page e size
Questi due parametri sono gestiti in coppia e permetto la gestione della paginazione. Sono parametri GET e hanno rispettivamente chiavi "page" e "size".
"page" indica il numero di pagina richiesto mentre "size" il numero di elementi per pagina.
Esempi completi di richieste
...