Documentazione API

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API, è necessario ottenere un token JWT valido tramite GetToken, fornendo il parametro apiKey (chiave di accesso creata in "Amministrazione -> Api Key"). Assicurarsi che il token JWT sia incluso come parametro token in tutte le richieste successive.

Passo 2: Formulare la richiesta Per ottenere l'elenco delle strutture di importazione (le "viste" dati) disponibili per l'ateneo, si utilizza il metodo HTTP POST all'endpoint /API/4/GetStruttureImportazioneRequest. La richiesta deve includere:

• apiKey: la chiave di accesso.
• token: il token JWT ottenuto al passo 1.
• ateneoKey: (opzionale) identificatore dell'ateneo; se omesso viene ricavato automaticamente dal token.

Passo 3: Eseguire la richiesta Invia la richiesta POST al server con i parametri indicati.

Passo 4: Elaborare la risposta La risposta contiene un array STRUTTURE con le strutture di importazione attive (tipo_importazione = 2) configurate per l'ateneo: strutturaKey (da usare come parametro strutturaKey nella successiva chiamata RequestJob), nome (nome della vista/tabella sorgente), descrizione e idTipoValutazione associato.

Questo metodo sostituisce il precedente meccanismo basato sul download di un file XML statico di configurazione, permettendo ai connettori esterni di scoprire dinamicamente le strutture disponibili prima di avviare un job con RequestJob e inviare i dati con SendData.

Ricorda di gestire eventuali errori durante il processo. 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.

Passo 1: Richiedere il token Questo è il primo metodo da chiamare, prima di qualunque altra richiesta. Non richiede un token JWT (a differenza di tutti gli altri metodi), ma solo il parametro apiKey: la chiave di accesso creata in "Amministrazione -> Api Key".

Passo 2: Formulare la richiesta Invia una richiesta HTTP POST all'endpoint /API/4/GetToken con il solo parametro apiKey nel body.

Passo 3: Elaborare la risposta La risposta contiene il campo token, una stringa JWT (HS256) firmata con la secret key associata alla apiKey. Questo token va incluso come parametro token in tutte le richieste successive, insieme alla stessa apiKey.

Il token non ha una scadenza gestita lato server: viene rivalidato ad ogni richiesta verificando la firma con la secret key corrente. Se la secret key viene rigenerata dall'amministratore, sarà necessario richiedere un nuovo token.

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API, è necessario ottenere un token JWT valido tramite GetToken, fornendo il parametro apiKey.

Passo 2: Formulare la richiesta Invia una richiesta HTTP POST all'endpoint /API/4/GetIndaginiRequest con i parametri apiKey, token e, opzionalmente, ateneoKey (se omesso viene ricavato dal token).

Passo 3: Elaborare la risposta La risposta contiene l'elenco INDAGINI: un array di coppie [id_tipo_valutazione, descrizione] per ciascun tipo di valutazione configurato per l'ateneo, ordinato secondo l'ordinamento configurato in amministrazione. Il valore id_tipo_valutazione va usato come parametro indagineKey nelle chiamate Get*TavolaRequest e Get*MedieRequest.

Ricorda di gestire eventuali errori durante il processo. I codici di errore comuni sono elencati nell'esempio di richiesta generica.

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API, è necessario ottenere un token JWT valido tramite GetToken.

Passo 2: Creare un JOB Prima di inviare i dati è necessario creare un job di importazione tramite RequestJob (azione add), specificando la strutturaKey ottenibile con GetStruttureImportazioneRequest. La risposta di RequestJob restituisce il jobKey da usare in questo metodo.

Passo 3: Formulare la richiesta Invia una richiesta HTTP POST all'endpoint /API/4/SendData con i parametri apiKey, token, ateneoKey, jobKey e data (un array non vuoto di oggetti, ciascuno rappresentante una riga da importare, con le chiavi corrispondenti ai campi mappati per la struttura in "Sistema -> Strutture importazione").

Passo 4: Elaborare la risposta Se l'invio ha successo, i dati vengono salvati e il job passa in stato di attesa elaborazione (in coda al processo batch schedulato). In caso di errore, verificare che il jobKey sia corretto e attivo, e che esista una mappatura campi (tb_excel_maps) per la struttura di importazione associata.

Ricorda di gestire eventuali errori durante il processo. 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.

Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API, è necessario ottenere un token JWT valido tramite GetToken.

Passo 2: Formulare la richiesta Invia una richiesta HTTP POST all'endpoint /API/4/GetStrutturaImportazioneMappaRequest con i parametri apiKey, token, strutturaKey (ottenibile da GetStruttureImportazioneRequest) e, opzionalmente, ateneoKey.

Passo 3: Elaborare la risposta La risposta contiene l'array CAMPI: un elemento per ogni colonna attesa nella vista/tabella sorgente da inviare con SendData. Ogni elemento riporta:

• colonnaVista: il nome esatto (maiuscole comprese) che la colonna deve avere nei dati inviati.
• campoDestinazione e tabellaDestinazione: il campo/tabella del sistema su cui verrà scritto il dato dopo l'elaborazione batch.
• obbligatorio: se true, il campo deve avere un valore non nullo per una corretta importazione.
• valoreDefault: valore usato quando la colonna manca o è vuota nei dati inviati (es. KEY_MAP_ATENEO viene sostituito automaticamente con l'ateneoKey della richiesta).

Questo metodo è pensato per essere chiamato prima di SendData, per costruire o verificare a runtime (o in fase di sviluppo di un connettore) la struttura esatta dei dati richiesti da una struttura di importazione, senza dover consultare manualmente sistema.tb_excel_maps.

Ricorda di gestire eventuali errori durante il processo. I codici di errore comuni sono elencati nell'esempio di richiesta generica.