ATTENZIONE: Il progetto attualmente è ancora in fase di sviluppo e verrà arricchito man mano con altre funzioni. Per eventuali segnalazioni riguardanti malfunzionamenti o suggerimenti contattare l'assistenza tramite il sistema di Ticket. Si raccomanda inoltre di controllare periodicamente il CHANGELOG delle utime modifiche effettuate.

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
TipoDescrizioneEsempio
stringStringa"stringa"
textStringa di lunghezza massima 3000 caratteri"stringa"
jsonJson{"it":"Stringa","en":"string"} se presente solo il testo in italaino può essere pasato solo il valore "Stringa"
integerNumero intero"123" o 123
doubleNumero decimale"123.45" o 123.45
booleanVariabile booleana"true", true, "false" o false
yearData nel formato YYYY"2024"
dateData nel formato YYYYMMDD"20240519"
date-timeData nel formato YYYYMMDD HH:mm:ss"20240519 14:12:42"
JWTJSON 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.

È importante notare che il nostro servizio API impone un limite massimo di 10.000 richieste ogni 5 ore per ogni singolo metodo. Superare questo limite potrebbe causare un'interruzione nel flusso delle richieste. Si consiglia di monitorare attentamente il numero di richieste effettuate e di gestire l'utilizzo delle API in modo coerente con questo limite.

Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/InfoRequest Metodo: InfoRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per verificare la correttezza dei parametri e visualizzare le informazioni sulla tua richiesta, utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/InfoRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita sarà un oggetto JSON contenente informazioni sulla correttezza dei tuoi parametri e sulle richieste rimanenti. Puoi elaborare la risposta come desiderato nella tua applicazione per verificare i dettagli e l'avanzamento delle tue richieste.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
Parametri Formato Token Struttura Token
apiKey (string) abbligatorio
token (JWT) abbligatorio
{
"apiKey": "",
"ateneoKey": ""
} 
JSONRequest {
apiKey (string) obbligatorio,
ateneoKey (integer) obbligatorio
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
403JSONForbidden. Request is missing valid credentials.
000JSONUnknown application response request.

Risposta in caso di successo
{
"success":true,
"response":"200",
"responseDescription":"The request has succeeded",
"token":{

"VERSION":"v4",

"SYSTEM":"SISValDidat - Sistema Informativo Statistico per la Valutazione della Didattica"

}

} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/MethodRequest Metodo: MethodRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per visualizzare i metodi disponibili nelle richieste API, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/MethodRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita sarà un oggetto JSON contenente i metodi disponibili per le richieste API. Puoi elaborare la risposta come desiderato nella tua applicazione per visualizzare i metodi disponibili.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
Parametri Formato Token Struttura Token
apiKey (string) abbligatorio
token (JWT) abbligatorio
{
"apiKey": "",
"ateneoKey": ""
} 
JSONRequest {
apiKey (string) obbligatorio,
ateneoKey (integer) obbligatorio
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{
"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"}}

} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetCDLTavolaRequest Metodo: GetCDLTavolaRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista dei dati presenti nella Tavola di rieplogo per un determinato Corso di Studi, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetCDLTavolaRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • html (opzionale): Un valore booleano che specifica se si desidera ottenere una tabella in formato HTML come output. Se non specificato, il formato di output sarà JSON.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desiderano i dati.
  • facoltaKey: Una stringa che rappresenta l'identificatore della Facoltà desiderata.
  • cdlKey: Una stringa che rappresenta l'identificatore del Corso di Studi desiderato.
  • sedeKey: Una stringa che rappresenta l'identificatore della Sede desiderata.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa al Corso di Studi.
  • semestreKey (opzionale): Un numero intero che rappresenta l'identificatore del semestre desiderato per filtrare i dati. Se non specificato, saranno restituiti i dati complessivi dell'intero anno.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita dipenderà dal formato di output specificato. Se html è impostato su true, verrà restituita una tabella in formato HTML. Altrimenti, verrà restituito un oggetto JSON contenente i dati richiesti. Puoi elaborare la risposta come desiderato nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{
"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]}
} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetFacoltaTavolaRequest Metodo: GetFacoltaTavolaRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista dei dati presenti nella Tavola di rieplogo per una determinata Scuola/Dipartimento, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetFacoltaTavolaRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • html (opzionale): Un valore booleano che specifica se si desidera ottenere una tabella in formato HTML come output. Se non specificato, il formato di output sarà JSON.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desiderano i dati.
  • sedeKey: Una stringa che rappresenta l'identificatore della Scuola/Dipartimento desiderata.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa alla Scuola/Dipartimento.
  • semestreKey (opzionale): Un numero intero che rappresenta l'identificatore del semestre desiderato per filtrare i dati. Se non specificato, saranno restituiti i dati complessivi dell'intero anno.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita dipenderà dal formato di output specificato. Se html è impostato su true, verrà restituita una tabella in formato HTML. Altrimenti, verrà restituito un oggetto JSON contenente i dati richiesti. Puoi elaborare la risposta come desiderato nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{
"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]}
} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetAteneoTavolaRequest Metodo: GetAteneoTavolaRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista dei dati presenti nella Tavola di rieplogo dell'Ateneo, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetAteneoTavolaRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • html (opzionale): Un valore booleano che specifica se si desidera ottenere una tabella in formato HTML come output. Se non specificato, il formato di output sarà JSON.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desiderano i dati.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa all'Ateneo.
  • semestreKey (opzionale): Un numero intero che rappresenta l'identificatore del semestre desiderato per filtrare i dati. Se non specificato, saranno restituiti i dati complessivi dell'intero anno.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita dipenderà dal formato di output specificato. Se html è impostato su true, verrà restituita una tabella in formato HTML. Altrimenti, verrà restituito un oggetto JSON contenente i dati richiesti. Puoi elaborare la risposta come desiderato nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{
"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]}
} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetAteneoMedieRequest Metodo: GetAteneoMedieRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista dei dati presenti nella Tavola di bersaglio dell'Ateneo, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetAteneoMedieRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • html (opzionale): Un valore booleano che specifica se si desidera ottenere una tabella in formato HTML come output. Se non specificato, il formato di output sarà JSON.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desiderano i dati.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa all'Ateneo.
  • semestreKey (opzionale): Un numero intero che rappresenta l'identificatore del semestre desiderato per filtrare i dati. Se non specificato, saranno restituiti i dati complessivi dell'intero anno.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita dipenderà dal formato di output specificato. Se html è impostato su true, verrà restituita una tabella in formato HTML. Altrimenti, verrà restituito un oggetto JSON contenente i dati richiesti. Puoi elaborare la risposta come desiderato nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{"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
]}
} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetFacoltaMedieRequest Metodo: GetFacoltaMedieRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista dei dati presenti nella Tavola di bersaglio della Scuola, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetFacoltaMedieRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • html (opzionale): Un valore booleano che specifica se si desidera ottenere una tabella in formato HTML come output. Se non specificato, il formato di output sarà JSON.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desiderano i dati.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa alla Scuola.
  • semestreKey (opzionale): Un numero intero che rappresenta l'identificatore del semestre desiderato per filtrare i dati. Se non specificato, saranno restituiti i dati complessivi dell'intero anno.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita dipenderà dal formato di output specificato. Se html è impostato su true, verrà restituita una tabella in formato HTML. Altrimenti, verrà restituito un oggetto JSON contenente i dati richiesti. Puoi elaborare la risposta come desiderato nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{"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
]}
} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetCDLMedieRequest Metodo: GetCDLMedieRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista dei dati presenti nella Tavola di bersaglio a livello di corso di studio, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetCDLMedieRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • html (opzionale): Un valore booleano che specifica se si desidera ottenere una tabella in formato HTML come output. Se non specificato, il formato di output sarà JSON.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desiderano i dati.
  • facoltaKey: Una stringa che rappresenta l'identificatore univoco della facoltà di riferimento.
  • cdlKey: Una stringa che rappresenta l'identificatore univoco del corso di laurea.
  • sedeKey: Una stringa che rappresenta l'identificatore univoco della sede.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa al corso di studio.
  • semestreKey (opzionale): Un numero intero che rappresenta l'identificatore del semestre desiderato per filtrare i dati. Se non specificato, saranno restituiti i dati complessivi dell'intero anno.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita dipenderà dal formato di output specificato. Se html è impostato su true, verrà restituita una tabella in formato HTML. Altrimenti, verrà restituito un oggetto JSON contenente i dati richiesti. Puoi elaborare la risposta come desiderato nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{"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
]}
} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetStudenteRequest Metodo: GetStudenteRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per verificare se uno studente ha compilato il questionario dell'insegnamento inviato, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetStudenteRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desidera effettuare la verifica.
  • facoltaKey: Una stringa che rappresenta l'identificatore univoco della facoltà di riferimento.
  • cdlKey: Una stringa che rappresenta l'identificatore univoco del corso di laurea.
  • utenteKey: Una stringa che rappresenta l'identificatore univoco dello studente per il quale si desidera effettuare la verifica.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa all'insegnamento.
  • insegnamentoKey: Un numero intero che rappresenta l'identificatore dell'insegnamento per il quale si desidera effettuare la verifica.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita sarà un valore booleano (true o false) che indica se lo studente ha compilato il questionario dell'insegnamento inviato o meno. Puoi elaborare la risposta come desiderato nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{
"success":true,
"response":"200",
"responseDescription":"The request has succeeded",
"token": {

         "codice insegnamento": true

} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetStudenteInsegnamentiRequest Metodo: GetStudenteInsegnamentiRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nella richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista degli insegnamenti compilati per gli studenti inviati, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetStudenteInsegnamentiRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desidera ottenere gli insegnamenti compilati.
  • facoltaKey: Una stringa che rappresenta l'identificatore univoco della facoltà di riferimento.
  • cdlKey: Una stringa che rappresenta l'identificatore univoco del corso di laurea.
  • utenteKey: Una stringa che rappresenta l'identificatore univoco dello studente per il quale si desidera ottenere gli insegnamenti compilati.
  • indagineKey: Un numero intero che rappresenta l'identificatore dell'indagine relativa agli insegnamenti.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita conterrà la lista degli insegnamenti compilati per gli studenti inviati. Puoi elaborare la risposta come desiderato, ad esempio, estrarre le informazioni rilevanti o visualizzare i dati nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. I codici di errore comuni sono elencati nell'esempio di richiesta generica, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
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
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{
"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,
		},
	
	


}

} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/GetPublicEngagementRequest Metodo: GetPublicEngagementRequest

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nella richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere la lista degli insegnamenti compilati per gli studenti inviati, si utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/GetPublicEngagementRequest. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • annoKey: Un campo di tipo "year" che specifica l'anno accademico per cui si desidera ottenere gli insegnamenti compilati

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita conterrà la lista degli insegnamenti compilati per gli studenti inviati. Puoi elaborare la risposta come desiderato, ad esempio, estrarre le informazioni rilevanti o visualizzare i dati nella tua applicazione.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. I codici di errore comuni sono elencati nell'esempio di richiesta generica, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
Parametri Formato Token Struttura Token
apiKey (string) abbligatorio
token (JWT) abbligatorio
{
"apiKey" : "",
"ateneoKey" : "",
"annoKey" : ""
} 
JSONRequest {
apiKey (string) obbligatorio,
ateneoKey (integer) obbligatorio,
annoKey (year) obbligatorio
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
401JSONForbidden. User does not exist.
000JSONUnknown application response request.

Risposta in caso di successo
{
"success":true,
"response":"200",
"responseDescription":"The request has succeeded",
"token": {


	{
	"Codice":"UNIFI-000000",
	"Titolo":"TITOLO",
	"Anno":2023,
	"Indagine":"Public engagement",
	"Url":"https:\/\/sisvaldidat.it\/AT-UNIFI\/AA-2023\/T-11\/VETRINA",
	"SSD":"INF\/01",
	"Descrizione":"DESCRIZIONE",
	"persone_coinvolte":"Prof.ssa ROSSI",
	},



	{
	"Codice":"UNIFI-0000001",
	"Titolo":"TITOLO",
	"Anno":2023,
	"Indagine":"Public engagement",
	"Url":"https:\/\/sisvaldidat.it\/AT-UNIFI\/AA-2023\/T-11\/VETRINA",
	"Descrizione":"DESCRIZIONE",
	"persone_coinvolte":"BIANCHI",
	},


}

} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
Richiesta: POST Tipologia: Invio URL: https://sisvaldidat.it/API/4/RequestJob Metodo: RequestJob

Descrizione e note

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per verificare la correttezza dei parametri e visualizzare le informazioni sulla tua richiesta, utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/RequestJob. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

  • apiKey: Una stringa che rappresenta la chiave di accesso.
  • ateneoKey: Un numero intero che identifica l'ateneo desiderato.
  • strutturaKey: Chiave del tipo di importazione che si vuole effettuare
  • azione: valori accettati add, delete e status
  • Parametro azione valore add:
    • CREATE: Indica che il job è stato creato e attende l'acquisizione dei dati.
    • EXISTS: Segnala che il job è già attivo e in attesa di ulteriori dati.
    • ERROR: Indica che il job non è stato creato con successo.
  • Parametro azione valore info:
    • EXISTS: Il job è attivo e in attesa di dati.
    • ERROR: Il job non è stato creato correttamente.
  • Parametro azione valore delete::
    • DELETE: Indica che il job è stato eliminato con successo.
    • Condizione: Il job può essere eliminato solamente quando si trova nello stato di attesa dei dati. Non è possibile eliminare il job una volta che l'importazione è terminata.

Si prega di notare che:

  • Il parametro azione restituisce diverse risposte a seconda dello stato del job al momento della richiesta.
  • Con il paramentro azione impostato con valore info consente di verificare lo stato corrente del job, fornendo informazioni se è attivo o se vi sono problemi di creazione.
  • Con il paramentro azione impostato con valore delete è disponibile solo quando il job si trova nello stato di "attesa dei dati". Una volta completata l'importazione, questa opzione non è più disponibile per l'eliminazione del job.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita sarà un oggetto JSON contenente informazioni sulla correttezza dei tuoi parametri e sulle richieste rimanenti. Puoi elaborare la risposta come desiderato nella tua applicazione per verificare i dettagli e l'avanzamento delle tue richieste.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.


Parametri richiesta
Parametri Formato Token Struttura Token
apiKey (string) abbligatorio
token (JWT) abbligatorio
{
"apiKey": "",
"ateneoKey": "",
"strutturaKey": "",
"azione": ""
} 
JSONRequest {
apiKey (string) obbligatorio,
ateneoKey (integer) obbligatorio,
strutturaKey (integer) obbligatorio,
azione (string) obbligatorio
} 

Risposta
Codice Risposta Descrizione
200JSONThe request has succeeded
201JSONLimited success. One or more batch requests failed for the command executed.
400JSONBad Request. One or more required parameters were missing or invalid
405JSONMethod not allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
702JSONMaximum number of requests within 5 hours has been exceeded.
900JSONExecution script in error.
701JSONStructure job code not present.
000JSONUnknown application response request.

Risposta in caso di successo
{
"success":true,
"response":"200",
"responseDescription":"The request has succeeded",
"token":{
"state":"CREATE",
"jobKey":"3484"
}
} 
Risposta in caso di fallimento
{
"success":false,
"response":"403",
"responseDescription":"Forbidden. Request is missing valid credentials."
} 
I cookie di questo sito servono al suo corretto funzionamento e non raccolgono alcuna informazione personale. Se navighi su di esso accetti la loro presenza.

Cookies policy