...
Per eseguire il login tramite token basta accedere direttamente alla route interessata inserendo però l'header authorization con valore "token=xxxxxxxxxxxxxx".
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.
Di seguito sono elencate le entità per le quali è disponibile una chiamata GET:
Entità | Route di base | Azione | Dati restituiti |
---|---|---|---|
Badge | badge | index | |
Contatti | contact | index | |
Eventi | event | index | |
Eventi | event | get-parent-events | Ritorna tutti gli eventi genitori dell'utente attuale |
Liste | list | index | |
Luoghi | hall | index | |
Mailing | mailing | index | |
Partecipanti | participant | index | |
Postazioni | location | index | |
Timbratori | timestamper | index |
Funzionamento 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.
Filtri
SOLO LE AZIONI le azioni "index" permettono anche di effettuare una ricerca impostando determinati filtri. 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
È 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.
Esempi completi di richieste
/list/index?accessToken=xxxxxxxxxxxxxxxxxxxxxxxxx&type=json
...