Reports
Di seguito venogno riportate le API esposte dal server per la richiesta dei report di utlizzo delle stanze
Indice
Report sanificazione stanze
L’amministratore è in grado di richiedere un report sulla sanificazione delle stanze che gli verrà fornito in formato pdf.
URL : /api/reports/cleaner
Metodo : GET
Autenticazione richiesta : SI
Permessi richiesti : ADMIN
Messaggi di successo
Condizione : Report creato con successo
Codice : 200 OK
Contenuto : documento pdf
Messaggi di errore
Codice | Motivazione |
---|---|
403 | permessi insufficenti |
500 | Errore nella creazione del report, contattare il team di sviluppo |
Report sull’utilizzo
L’amministratore è in grado di richiedere un report sull’utilizzo delle stanze e delle singole postazioni, che gli verrà fornito in formato pdf.
URL : /api/reports/usage
Metodo : GET
Autenticazione richiesta : SI
Permessi richiesti : ADMIN
Messaggi di successo
Condizione : Report creato con successo
Codice : 200 OK
Contenuto : documento pdf
Messaggi di errore
Codice | Motivazione |
---|---|
403 | permessi insufficenti |
500 | Errore nella creazione del report, contattare il team di sviluppo |
Lista dei report creati
L’amministratore è in grado di ricevere una lista di tutti i pdf creati dall’avvio del server in poi
URL : /api/reports/all
Metodo : GET
Autenticazione richiesta : SI
Permessi richiesti : ADMIN
Messaggi di successo
Condizione : Lista dei report generata con successo
Codice : 200 OK
Contenuto :
[
{
"name": "string",
"creationDate": "time",
"registrationDate": "time"
},
...
]
Messaggi di errore
Codice | Motivazione |
---|---|
403 | permessi insufficenti |
500 | Errore nella creazione del report, contattare il team di sviluppo |
Richiesta download report già generato
L’amministratore è in grado di scaricare i report già creati dal sistema.
URL : /api/reports/report/{reportName}
Parametri URL :
{reportName}
: Nome del report. reperibile dalla lista dei report creati
Metodo : GET
Autenticazione richiesta : SI
Permessi richiesti : ADMIN
Messaggi di successo
Condizione : Report presente nel sistema e correttamente restituito
Codice : 200 OK
Contenuto risposta : pdf richiesto
Messaggi di errore
Codice | Motivazione |
---|---|
400 | Sintassi del nome utente non valida |
403 | permessi insufficenti |
404 | Report non presente, nome errato |
500 | errore di IO nel reperimento del report, contattare il manutentore del sistema |