API - OpencontentCoop/openpa_consiglio GitHub Wiki
Le api a disposizione del gestionale sono interrogabili via REST con autenticazione base e restituiscono oggetti in JSON:
| Endpoint | Descrizione | Parametri accettati | Valori restituiti |
|---|---|---|---|
GET api/consiglio/v1/auth |
Esegue il login in base ai parametri inviati | ?login string nome utente ?password string password in chiaro |
LoginResult |
| utente | |||
GET api/consiglio/v1/utente/:Id |
Restituisce l'utente di cui all’Id richiesto | :Id integer Id Utente/Politico |
Politico |
GET api/consiglio/v1//utente/:Id/latest_data |
Restituisce le informazioni aggiornate dell'utente di cui all’Id richiesto nel contesto dell'utlima seduta/punto/votazione svolta | :Id integer Id Utente |
LatestData |
| seduta | |||
GET api/consiglio/v1/seduta/list |
Restituisce la lista delle sedute presenti | ?limit integer limite della query ?offset integer offset della query ?interval string DateInterval filtro per intervallo temporale rispetto alla data corrente ?state integer o string filtro per stato della seduta ?query string filtro per query string |
array di Seduta |
GET api/consiglio/v1/seduta/:Id |
Restituisce la seduta di cui all’Id richiesto | :Id integer Id Seduta |
Seduta |
GET api/consiglio/v1/seduta/:Id/odg |
Restituisce l'ordine del giorno della seduta di cui all’Id richiesto | :Id integer Id Seduta |
array di Punto |
GET api/consiglio/v1/seduta/:Id/documenti |
Restituisce i documenti allegati alla seduta di cui all’Id richiesto | :Id integer Id Seduta |
array di Allegato |
GET api/consiglio/v1/seduta/:Id/presenze |
Restituisce i marcatori di presenza registrati nella seduta di cui all’Id richiesto | :Id integer Id Seduta ?start_time integer timestamp ?in_out booelan marcatura presente/assente ?type string tipo di rilevazione ?user_id integer filtro per utente |
array di Presenza |
GET api/consiglio/v1//seduta/:Id/presenze/:UserId |
Restituisce l'ultimo marcatore di presenza per ciscun tipo per l'utente UserId nella seduta di cui all’Id richiesto | :Id integer Id Seduta :UserId integer Id Utente |
array di Presenza |
GET api/consiglio/v1/seduta/:Id/votazioni |
Restituisce la lista delle votazioni predisposte per la seduta di cui all’Id richiesto | :Id integer Id Seduta |
array Votazione |
POST api/consiglio/v1/seduta/:Id/presenza |
Inserimento marcature di presenza nel registro delle presenza della seduta di cui all’Id richiesto | :Id integer Id Seduta ?in_out boolean presente/assente ?type string tipo di marcatura ?user_id integer Id Utente/Politico |
Presenza |
| punto | |||
GET api/consiglio/v1/punto/:Id |
Restituisce il punto di cui all’Id richiesto | :Id integer Id Punto |
Punto |
GET api/consiglio/v1/punto/:Id/documenti |
Restituisce i documenti allegati al punto di cui all’Id richiesto | :Id integer Id Punto |
array di Osservazione |
GET api/consiglio/v1/punto/:Id/osservazioni |
Restituisce le osservazioni al punto di cui all’Id richiesto | :Id integer Id Punto |
array di Allegato |
GET api/consiglio/v1/punto/:Id/votazioni |
Restituisce le votazioni relative al punto di cui all’Id richiesto | :Id integer Id Punto |
array di Votazione |
| allegato | |||
GET api/consiglio/v1/allegato/:Id |
Restituisce l'allegato di cui all’Id richiesto | :Id integer Id Allegato |
Allegato |
GET api/consiglio/v1/allegato/:Id/download |
Esegue il download dell'allegato di cui all’Id richiesto | :Id integer Id Allegato |
binary |
| osservazione | |||
GET api/consiglio/v1/osservazione/:Id/download |
Esegue il download dell'osservazione di cui all’Id richiesto | :Id integer Id Osservazione |
binary |
| presenza | |||
GET api/consiglio/v1/presenza/:Id |
Restituisce il marcatore di presenza di cui all’Id richiesto | :Id integer Id Presenza |
Presenza |
| votazione | |||
GET api/consiglio/v1/votazione/:Id |
Restituisce la votazione di cui all’Id richiesto | :Id integer Id Votazione |
Votazione |
POST api/consiglio/v1/votazione/:Id |
Inserisce un voto per la votazione di cui all’Id richiesto | :Id integer Id Votazione ?value string Valore del voto ?user_id integer Id Utente/Politco |
VotoResult |
GET api/consiglio/v1/votazione/:Id/user_status/:UserId |
Restituisce lo stato dell'utente :UserId per la votazione :Id oppure lo stato della votazione se l'utente non ha ancora effettuato il voro | :Id integer Id Votazione:UserId integer Id Utente |
string done, waiting, pending, closed |
LoginResult Politico LatestData Seduta Allegato Osservazione Punto Presenza Votazione VotoResult