Documentazione API e ambiente di test
Il modello attuale prevede una richiesta di tipo POST, con i parametri codificati in formato JSON nel corpo della richiesta stessa. I formati dei parametri sono elencati nella tabella sottostante e variano a seconda della tipologia.
Formato dei parametri
Tipo | Descrizione | Esempio |
---|---|---|
string | Stringa | "stringa" |
integer | Numero intero | "123" o 123 |
double | Numero decimale | "123.45" o 123.45 |
boolean | Variabile booleana | "true", true, "false" o false |
year | Data nel formato YYYY | "2023" |
date | Data nel formato YYYYMMDD | "20230329" |
date-time | Data nel formato YYYYMMDD HH:mm:ss | "20230329 00:03:25" |
JWT | JSON Web Token algoritmo HS256 | "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" |
Il parametro apiKey
è necessari per effettuare
qualsiasi operazione
e deve essere inserito sia come parametro JSON del Token che come parametro di tutte le richieste.
Il parametro ateneoKey
è necessari per effettuare
qualsiasi operazione e deve essere inserito come parametro JSON nel Token di tutte le richieste.
L'endpoint di riferimento si trova all'indirizzo https://sisvaldidat.it/API/4
,
per cui le richieste sono nel formato https://sisvaldidat.it/API/4/operazione
.
L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici ad una funzione sono elencati nella sezione della funzione stessa.
Modello di una richiesta generica in formato JSON per API. Utilizzala per verificare la correttezza dei tuoi parametri e le richieste che ti rimangono.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey": "", "ateneoKey": "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
401 | Forbidden. User does not exist. | |
403 | Forbidden. Request is missing valid credentials. | |
000 | Unknown application response request. |
{ "success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{ "VERSION":"v4", "SYSTEM":"SISValDidat - Sistema Informativo Statistico per la Valutazione della Didattica" } }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Modello di una richiesta generica in formato JSON per API. Utilizzala per visualizzare i metodi disponibili nelle richieste API.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey": "", "ateneoKey": "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{ "success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{"METHOD":{"InfoRequest":{"class":"API_Handler","function_name":"InfoRequest"},"MethodRequest":"class":"API_Handler","function_name":"MethodRequest"}} }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce la lista contenente i dati presenti nella Tavola di rieplogo per un determinto Corso di Studi. I dati possono essere filtrati con il parametro "semestreKey". Nel caso non sia specificato l'API restiturisce i dati complessivi dell'intero anno.
Utilizzando il paramentro "html" settato a true è possibile ottenere come output una tabella in formato HTML on altro caso il formato in uscita è JSON.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "html" : "", "annoKey" : "", "facoltaKey" : "", "cdlKey" : "", "sedeKey" : "", "indagineKey" : "", "semestreKey" : "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, html (boolean) opzionale, annoKey (year) obbligatorio, facoltaKey (string) obbligatorio, cdlKey (string) obbligatorio, sedeKey (string) obbligatorio, indagineKey (integer) obbligatorio, semestreKey (integer) opzionale } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
201 | JSON | Limited success. One or more batch requests failed for the command executed. |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{ "success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{"TITOLO":["Testo Domanda","Sezione","Esadecimale Sezione","Risposte","Non Risposte","P1","P2","Media","SQM","L1","L2"],"D1":["Il carico di lavoro complessivo degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",349,0,4.297994269340974,95.70200573065902,"8.6532951289398281","1.5341408829881",8.49233859868189,8.814251659197765],"D2":["L'organizzazione complessiva (orario, esami, intermedi e finali) degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",222,127,1.3513513513513513,98.64864864864865,"8.8918918918918919","1.32740928468737",8.717275731175503,9.06650805260828],"D3":["L'orario delle lezioni e' congegnato in modo tale da consentire un'adeguata attivita' di studio individuale?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",180,169,3.3333333333333335,96.66666666666667,"8.7722222222222222","1.40163733287582",8.567457340289582,8.976987104154862],"D4":["Le conoscenze preliminari possedute sono risultate sufficienti per la comprensione degli argomenti trattati?","ORGANIZZAZIONE INSEGNAMENTO","#680032",349,0,6.59025787965616,93.40974212034384,"8.4928366762177650","1.88858647781038",8.294692992067752,8.690980360367778]} }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce la lista contenente i dati presenti nella Tavola di rieplogo per una determinta Scuola/Dipartimento. I dati possono essere filtrati con il parametro "semestreKey". Nel caso non sia specificato l'API restiturisce i dati complessivi dell'intero anno.
Utilizzando il paramentro "html" settato a true è possibile ottenere come output una tabella in formato HTML on altro caso il formato in uscita è JSON.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "html" : "", "annoKey" : "", "facoltaKey" : "", "indagineKey" : "", "semestreKey" : "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, html (boolean) opzionale annoKey (year) obbligatorio, sedeKey (string) obbligatorio, indagineKey (integer) obbligatorio, semestreKey (integer) opzionale } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
201 | JSON | Limited success. One or more batch requests failed for the command executed. |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{ "success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{"TITOLO":["Testo Domanda","Sezione","Esadecimale Sezione","Risposte","Non Risposte","P1","P2","Media","SQM","L1","L2"],"D1":["Il carico di lavoro complessivo degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",349,0,4.297994269340974,95.70200573065902,"8.6532951289398281","1.5341408829881",8.49233859868189,8.814251659197765],"D2":["L'organizzazione complessiva (orario, esami, intermedi e finali) degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",222,127,1.3513513513513513,98.64864864864865,"8.8918918918918919","1.32740928468737",8.717275731175503,9.06650805260828],"D3":["L'orario delle lezioni e' congegnato in modo tale da consentire un'adeguata attivita' di studio individuale?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",180,169,3.3333333333333335,96.66666666666667,"8.7722222222222222","1.40163733287582",8.567457340289582,8.976987104154862],"D4":["Le conoscenze preliminari possedute sono risultate sufficienti per la comprensione degli argomenti trattati?","ORGANIZZAZIONE INSEGNAMENTO","#680032",349,0,6.59025787965616,93.40974212034384,"8.4928366762177650","1.88858647781038",8.294692992067752,8.690980360367778]} }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce la lista contenente i dati presenti nella Tavola di rieplogo dell'Ateneo. I dati possono essere filtrati con il parametro "semestreKey". Nel caso non sia specificato l'API restiturisce i dati complessivi dell'intero anno.
Utilizzando il paramentro "html" settato a true è possibile ottenere come output una tabella in formato HTML on altro caso il formato in uscita è JSON.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "html": "", "annoKey" : "", "indagineKey" : "", "semestreKey" : "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, html (boolean) opzionale annoKey (year) obbligatorio, indagineKey (integer) obbligatorio, semestreKey (integer) opzionale } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
201 | JSON | Limited success. One or more batch requests failed for the command executed. |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{ "success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{"TITOLO":["Testo Domanda","Sezione","Esadecimale Sezione","Risposte","Non Risposte","P1","P2","Media","SQM","L1","L2"],"D1":["Il carico di lavoro complessivo degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",349,0,4.297994269340974,95.70200573065902,"8.6532951289398281","1.5341408829881",8.49233859868189,8.814251659197765],"D2":["L'organizzazione complessiva (orario, esami, intermedi e finali) degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",222,127,1.3513513513513513,98.64864864864865,"8.8918918918918919","1.32740928468737",8.717275731175503,9.06650805260828],"D3":["L'orario delle lezioni e' congegnato in modo tale da consentire un'adeguata attivita' di studio individuale?","ORGANIZZAZIONE CORSO DI STUDI","#ff761a",180,169,3.3333333333333335,96.66666666666667,"8.7722222222222222","1.40163733287582",8.567457340289582,8.976987104154862],"D4":["Le conoscenze preliminari possedute sono risultate sufficienti per la comprensione degli argomenti trattati?","ORGANIZZAZIONE INSEGNAMENTO","#680032",349,0,6.59025787965616,93.40974212034384,"8.4928366762177650","1.88858647781038",8.294692992067752,8.690980360367778]} }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce la lista contenente i dati presenti nella Tavola di bersaglio dell'Ateneo. I dati possono essere filtrati con il parametro "semestreKey". Nel caso non sia specificato l'API restiturisce i dati complessivi dell'intero anno.
Utilizzando il paramentro "html" settato a true è possibile ottenere come output una tabella in formato HTML on altro caso il formato in uscita è JSON.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "html": "", "annoKey" : "", "indagineKey" : "", "semestreKey" : "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, html (boolean) opzionale annoKey (year) obbligatorio, indagineKey (integer) obbligatorio, semestreKey (integer) opzionale } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
201 | JSON | Limited success. One or more batch requests failed for the command executed. |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{"success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{ "TITOLO":[ "Esadecimale Sezione", "Testo Domanda", "Sezione", "Risposte", "Media"], "D1":[ "#ff761a", "Il carico di lavoro complessivo degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?", "ORGANIZZAZIONE CdS", 215201, 7.616 ]} }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce la lista contenente i dati presenti nella Tavola di bersaglio della Scuola. I dati possono essere filtrati con il parametro "semestreKey". Nel caso non sia specificato l'API restiturisce i dati complessivi dell'intero anno.
Utilizzando il paramentro "html" settato a true è possibile ottenere come output una tabella in formato HTML on altro caso il formato in uscita è JSON.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "html": "", "annoKey" : "", "indagineKey" : "", "semestreKey" : "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, html (boolean) opzionale annoKey (year) obbligatorio, indagineKey (integer) obbligatorio, semestreKey (integer) opzionale } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
201 | JSON | Limited success. One or more batch requests failed for the command executed. |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{"success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{ "TITOLO":[ "Esadecimale Sezione", "Testo Domanda", "Sezione", "Risposte", "Media"], "D1":[ "#ff761a", "Il carico di lavoro complessivo degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?", "ORGANIZZAZIONE CdS", 215201, 7.616 ]} }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce la lista contenente i dati presenti nella Tavola di bersaglio a livello di corso di studio. I dati possono essere filtrati con il parametro "semestreKey". Nel caso non sia specificato l'API restiturisce i dati complessivi dell'intero anno.
Utilizzando il paramentro "html" settato a true è possibile ottenere come output una tabella in formato HTML on altro caso il formato in uscita è JSON.
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "html" : "", "annoKey" : "", "facoltaKey" : "", "cdlKey" : "", "sedeKey" : "", "indagineKey" : "", "semestreKey" : "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, html (boolean) opzionale, annoKey (year) obbligatorio, facoltaKey (string) obbligatorio, cdlKey (string) obbligatorio, sedeKey (string) obbligatorio, indagineKey (integer) obbligatorio, semestreKey (integer) opzionale } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
201 | JSON | Limited success. One or more batch requests failed for the command executed. |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{"success":true, "response":"200", "responseDescription":"The request has succeeded", "token":{ "TITOLO":[ "Esadecimale Sezione", "Testo Domanda", "Sezione", "Risposte", "Media"], "D1":[ "#ff761a", "Il carico di lavoro complessivo degli insegnamenti ufficialmente previsti nel periodo di riferimento (bimestre, trimestre, semestre, ecc.) \u00e8 accettabile?", "ORGANIZZAZIONE CdS", 215201, 7.616 ]} }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce true nel caso lo studente ha compilato il questionario dell'insegnamento inviato o false nel caso contrario
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "annoKey" : "", "facoltaKey" : "", "cdlKey" : "", "utenteKey" : "", "indagineKey" : "", "insegnamentoKey" : "" } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, annoKey (year) obbligatorio, facoltaKey (string) obbligatorio, cdlKey (string) obbligatorio, utenteKey (string) obbligatorio, indagineKey (integer) obbligatorio, insegnamentoKey (integer) obbligatori } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{ "success":true, "response":"200", "responseDescription":"The request has succeeded", "token": { "codice insegnamento": true }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }
Restituisce la lista degli insegnamenti compilati per gli studenti inviati
Parametri | Formato Token | Struttura Token |
---|---|---|
apiKey (string) abbligatorio token (JWT) abbligatorio |
{ "apiKey" : "", "ateneoKey" : "", "annoKey" : "", "facoltaKey" : "", "cdlKey" : "", "utenteKey" : "", "indagineKey" : "", } |
JSONRequest { apiKey (string) obbligatorio, ateneoKey (integer) obbligatorio, annoKey (year) obbligatorio, facoltaKey (string) obbligatorio, cdlKey (string) obbligatorio, utenteKey (string) obbligatorio, indagineKey (integer) obbligatorio } |
Codice | Risposta | Descrizione |
---|---|---|
200 | JSON | The request has succeeded |
400 | Bad Request. One or more required parameters were missing or invalid | |
405 | Method not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. | |
401 | Forbidden. User does not exist. | |
000 | Unknown application response request. |
{ "success":true, "response":"200", "responseDescription":"The request has succeeded", "token": { "CODICE UTENTE": [ { "indagineKey": , "indagineDesc":"---", "facoltaKey":"---", "cdlKey":"----", "insegnamentoKey":"----", "codice insegnamento":true, "statoDesc":"complete", "statoKey":1, }, { "indagineKey":, "indagineDesc":"---", "facoltaKey":"---", "cdlKey":"---", "insegnamentoKey":"---", "codice insegnamento":false, "statoDesc":"incomplete", "statoKey":0, }, } }
{ "success":false, "response":"403", "responseDescription":"Forbidden. Request is missing valid credentials." }