Madisoft S.p.A.
            Centro assistenza Nuvola Consigli di Nuvola Generale

            Nuvola Api Rest

            Struttura delle chiamate

            Tutti gli endpoint si basano sui principi REST e ritornano metadati JSON delle informazioni richieste.

            Sono accessibili tramite richieste standard HTTPS in formato UTF-8.

            Tutte le Response consistono di oggetti JSON (come dettagliati di seguito).


            Tutti i timestamps sono nel formato YYYY-MM-DD HH:MM:SS.

            Tutti gli endpoints finalizzati all’estrazione di risorse multiple permettono la paginazione dei dataset estratti.

            Autenticazione

            Tutte le richieste inviate alle API Web richiedono autenticazione mediante l’invio di un token nell’header della request.

            Gestione degli errori

            Tutti gli errori sono indicati riportando il codice dell’errore nello stato HTTP della response. E’ previsto l’utilizzo dei seguenti codici di errore.



            CODICE

            DESCRIZIONE

            400

            Bad Request (sintassi non corretta della request)

            401

            Unauthorized (permessi di accesso insufficienti per la risorsa)

            403

            Forbidden (il server non è in grado di soddisfare la richiesta)

            404

            Not Found (risorsa non trovata)

            500

            Internal Server Error (malfunzionamento dell’applicazione)

            503

            Service Unavailable (servizio non disponibile)


            Il corpo della reponse, in caso di errore, sarà sempre costituito da un oggetto di tipo “error” avente la seguente struttura:


            Oggetto error


            KEY

            TIPO

            DESCRIZIONE

            status

            integer

            Il codice HTTP di errore.

            descrizione

            string

            Breve descrizione dell’errore

            API Endpoints Reference

            Area personale

            Base Url:https://nuvola.madisoft.it/api/area-personale

            Servizi

            Endpoints per estrarre le informazioni dei servizi del personale

            METHOD

            ENDPOINT

            UTILIZZO

            TIPO RITORNATO

            GET

            /get-servizi

            Fornisce l’elenco dei servizi

            servizi

            GET

            /get-servizio/{id}

            Fornisce il dettaglio di un servizio

            servizio


            Endpoint get-servizi

            GET https://nuvola.madisoft.it/api/area-personale/%7Btenant%7D/get-servizi


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.



            Parametri query


            PARAMETRO

            OBBLIGATORIO

            VALORE

            limit

            No

            Massimo numero di servizi da ritornare. Default: 20. Minimo: 1. Massimo: 50.

            offset

            No

            L’indice del primo elemento da ritornare. Default: 0. Usare assieme a “limit” per ottenere l’insieme successivo di servizi.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto con un campo “servizi” contenente un array di oggetti “servizio” all’interno di un oggetto “paging”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto servizio


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del servizio.

            id

            string

            Id del servizio

            dipendente

            string

            Nome e cognome del dipendente

            inizio

            date

            Data inizio del servizio

            fine

            date

            Data fine del servizio


            Oggetto paging


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della richiesta.

            items

            array di oggetti

            I dati richiesti

            limit

            integer

            Massimo numero di items nella response

            next

            string

            Link alla pagina successiva di items (null se non presenti)

            offset

            integer

            Posizione del primo elemento ritornato

            previous

            string

            Link alla pagina precedente di items (null se non presenti)

            totale

            integer

            Numero totale di items da ritornare.


            Endpoint get-servizio

            GET https://nuvola.madisoft.it/api/area-personale/%7Btenant%7D/get-servizio/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id del servizio richiesto.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “servizio”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto servizio


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del servizio.

            id

            string

            Id del servizio

            dipendente

            string

            Nome e cognome del dipendente

            inizio

            date

            Data inizio del servizio

            fine

            date

            Data fine del servizio

            titolare

            boolean

            Se il dipendente ha la titolarità del ruolo svolto

            tipo_parttime

            string

            La tipologia di part time

            percentuale_partime

            integer

            La percentuale di part time

            codice_sede

            string

            Il codice meccanografico della sede di servizio

            ore_settimanali

            integer

            Le ore settimanali di lavoro

            annotazioni

            string

            Le annotazioni inserite nel servizio.


            Contratti

            Endpoints per estrarre le informazioni dei contratti del personale

            METHOD

            ENDPOINT

            UTILIZZO

            TIPO RITORNATO

            GET

            /get-contratti

            Fornisce l’elenco dei contratti

            contratti

            GET

            /get-contratto/{id}

            Fornisce il dettaglio di un contratto

            contratto


            Endpoint get-contratti

            GET https://nuvola.madisoft.it/api/area-personale/%7Btenant%7D/get-contratti


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.



            Parametri query


            PARAMETRO

            OBBLIGATORIO

            VALORE

            limit

            No

            Massimo numero di contratti da ritornare. Default: 20. Minimo: 1. Massimo: 50.

            offset

            No

            L’indice del primo elemento da ritornare. Default: 0. Usare assieme a “limit” per ottenere l’insieme successivo di contratti.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto con un campo “contratti” contenente un array di oggetti “contratto” all’interno di un oggetto “paging”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto servizio


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del contratto.

            id

            string

            Id del contratto

            dipendente

            string

            Nome e cognome del dipendente

            data

            date

            Data del contratto


            Oggetto paging


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della richiesta.

            items

            array di oggetti

            I dati richiesti

            limit

            integer

            Massimo numero di items nella response

            next

            string

            Link alla pagina successiva di items (null se non presenti)

            offset

            integer

            Posizione del primo elemento ritornato

            previous

            string

            Link alla pagina precedente di items (null se non presenti)

            totale

            integer

            Numero totale di items da ritornare.


            Endpoint get-contratto

            GET https://nuvola.madisoft.it/api/area-personale/%7Btenant%7D/get-contratto/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id del contratto richiesto.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “contratto”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto contratto


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del contratto.

            id

            string

            Id del contratto

            dipendente

            string

            Nome e cognome del dipendente

            data

            date

            Data del contratto

            annotazioni

            string

            Le annotazioni inserite nel servizio.

            tipo_nomina

            string

            Il tipo di nomina

            qualifica

            string

            Il tipo di qualifica del dipendente

            profilo

            string

            Il profilo professionale assegnato al dipendente

            numero

            string

            Il numero del contratto

            part_time

            boolean

            Se il rapporto di lavoro è part time

            numero_protocollo

            string

            Il numero di protocollo associato al contratto

            data_protocollo

            datetime

            La data e ora del protocollo del contratto


            Area alunni/Registro elettronico

            Base Url: https://nuvola.madisoft.it/api/area-alunni

            Alunni

            Endpoints per estrarre le informazioni degli alunni

            METHOD

            ENDPOINT

            UTILIZZO

            TIPO RITORNATO

            GET

            /get-alunni

            Fornisce l’elenco degli alunni

            alunni

            GET

            /get-alunno/{id}

            Fornisce il dettaglio di un alunno

            alunno


            Endpoint get-alunni

            GET https://nuvola.madisoft.it/api/area-alunni/%7Btenant%7D/get-alunni


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.



            Parametri query


            PARAMETRO

            OBBLIGATORIO

            VALORE

            limit

            No

            Massimo numero di alunni da ritornare. Default: 20. Minimo: 1. Massimo: 50.

            offset

            No

            L’indice del primo elemento da ritornare. Default: 0. Usare assieme a “limit” per ottenere l’insieme successivo di alunni.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto con un campo “alunni” contenente un array di oggetti “alunno” all’interno di un oggetto “paging”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto alunno


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio dell’alunno.

            id

            string

            Id dell’alunno

            nome

            string

            Nome dell’alunno

            cognome

            string

            Cognome dell’alunno

            classe

            string

            Classe dell’alunno

            href_classe

            string

            Link all’endpoint che ritorna il dettaglio della classe..


            Oggetto paging


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della richiesta.

            items

            array di oggetti

            I dati richiesti

            limit

            integer

            Massimo numero di items nella response

            next

            string

            Link alla pagina successiva di items (null se non presenti)

            offset

            integer

            Posizione del primo elemento ritornato

            previous

            string

            Link alla pagina precedente di items (null se non presenti)

            totale

            integer

            Numero totale di items da ritornare.


            Endpoint get-alunno

            GET https://nuvola.madisoft.it/api/area-alunni/%7Btenant%7D/get-alunno/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id dell’alunno richiesto.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “alunno”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto alunno


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio dell’alunno.

            id

            string

            Id dell’alunno

            nome

            string

            Nome dell’alunno

            cognome

            string

            Cognome dell’alunno

            classe

            string

            Classe dell’alunno

            href_classe

            string

            Link all’endpoint che ritorna il dettaglio della classe.

            codice_fiscale

            string

            Codice fiscale dell’alunno

            data_nascita

            date

            Data nascita dell’alunno

            luogo_nascita

            string

            Denominazione comune e provincia di nascita

            cittadinanza

            string

            Cittadinanza dell’alunno

            stato_frequenza

            string

            Stato di frequenza dell’alunno

            corso

            string

            Corso assegnato all’alunno

            piano_studio

            string

            Piano di studio dell’alunno

            codice_sidi

            string

            Codice sidi dell’alunno


            Classi

            Endpoints per estrarre le informazioni delle classi

            METHOD

            ENDPOINT

            UTILIZZO

            TIPO RITORNATO

            GET

            /get-classi

            Fornisce l’elenco delle classi

            classi

            GET

            /get-classe/{id}

            Fornisce il dettaglio di una classe

            classe


            Endpoint get-classi

            GET https://nuvola.madisoft.it/api/area-alunni/%7Btenant%7D/get-classi


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.



            Parametri query


            PARAMETRO

            OBBLIGATORIO

            VALORE

            limit

            No

            Massimo numero di classi da ritornare. Default: 20. Minimo: 1. Massimo: 50.

            offset

            No

            L’indice del primo elemento da ritornare. Default: 0. Usare assieme a “limit” per ottenere l’insieme successivo di classi.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto con un campo “classi” contenente un array di oggetti “classe” all’interno di un oggetto “paging”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto classe


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della classe.

            id

            string

            Id della classe

            anno_cronologico

            string

            Anno cronologico della classe (es, 1, 2…)

            sezione

            string

            Sezione della classe

            anno_scolastico

            string

            Anno scolastico della classe (es, 2018/2019)


            Oggetto paging


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della richiesta.

            items

            array di oggetti

            I dati richiesti

            limit

            integer

            Massimo numero di items nella response

            next

            string

            Link alla pagina successiva di items (null se non presenti)

            offset

            integer

            Posizione del primo elemento ritornato

            previous

            string

            Link alla pagina precedente di items (null se non presenti)

            totale

            integer

            Numero totale di items da ritornare.


            Endpoint get-classe

            GET https://nuvola.madisoft.it/api/area-alunni/%7Btenant%7D/get-classe/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id della classe richiesta.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “classe”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto classe


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della classe.

            id

            string

            Id della classe

            anno_cronologico

            string

            Anno cronologico della classe (es, 1, 2…)

            sezione

            string

            Sezione della classe

            anno_scolastico

            string

            Anno scolastico della classe (es, 2018/2019)

            sede

            string

            Denominazione della sede

            alunni

            array

            Array di oggetti di tipo “alunno”


            Oggetto alunno


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio dell’alunno.

            id

            string

            Id dell’alunno

            nome

            string

            Nome dell’alunno

            cognome

            string

            Cognome dell’alunno


            Amministrazione digitale

            Base Url: https://nuvola.madisoft.it/api/amministrazione-digitale

            Documenti

            Endpoints per estrarre le informazioni dei documenti

            METHOD

            ENDPOINT

            UTILIZZO

            TIPO RITORNATO

            GET

            /get-documenti

            Fornisce l’elenco dei documenti

            documenti

            GET

            /get-documento/{id}

            Fornisce il dettaglio di un documento

            documento

            GET

            get-allegato/{id}

            Fornisce il dettaglio di un allegato

            allegato

            GET

            get-registro/{id}

            Fornisce il dettaglio di un registro

            registro


            Endpoint get-documenti

            GET https://nuvola.madisoft.it/api/amministrazione-digitale/%7Btenant%7D/get-documenti


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.



            Parametri query


            PARAMETRO

            OBBLIGATORIO

            VALORE

            limit

            No

            Massimo numero di documenti da ritornare. Default: 20. Minimo: 1. Massimo: 50.

            offset

            No

            L’indice del primo documento da ritornare. Default: 0. Usare assieme a “limit” per ottenere l’insieme successivo di documenti.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto con un campo “documenti” contenente un array di oggetti “documento” all’interno di un oggetto “paging”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto documento


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del documento.

            id

            string

            Id del documento

            direzione

            string

            Direzione del documento (es, Entrata, Uscita)

            mezzo

            string

            Mezzo di trasmissione del documento (Es, email, a mano etc..)

            oggetto

            string

            Oggetto del documento


            Oggetto paging


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della richiesta.

            items

            array di oggetti

            I dati richiesti

            limit

            integer

            Massimo numero di items nella response

            next

            string

            Link alla pagina successiva di items (null se non presenti)

            offset

            integer

            Posizione del primo elemento ritornato

            previous

            string

            Link alla pagina precedente di items (null se non presenti)

            totale

            integer

            Numero totale di items da ritornare.


            Endpoint get-documento

            GET https://nuvola.madisoft.it/api//amministrazione-digitale/%7Btenant%7D/get-documento/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id del documento richiesto.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “documento”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto documento



            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del documento.

            id

            string

            Id del documento

            direzione

            string

            Direzione del documento (es, Entrata, Uscita)

            mezzo

            string

            Mezzo di trasmissione del documento (Es, email, a mano etc..)

            oggetto

            string

            Oggetto del documento

            mittenti

            array

            Array di stringhe con le denominazioni dei mittenti

            destinatari

            array

            Array di stringhe con le denominazioni dei destinatari

            allegati

            array

            Array di oggetti di tipo allegato

            registri

            array

            Array di oggetti di tipo registro


            Oggetto allegato



            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio dell’allegato.

            nome

            string

            Nome del file allegato


            Oggetto registro



            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del registro.

            nome

            string

            Nome del registro


            Endpoint get-allegato

            GET https://nuvola.madisoft.it/api//amministrazione-digitale/%7Btenant%7D/get-allegato/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id dell’allegato richiesto.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “allegato”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.



            Oggetto allegato



            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio dell’allegato.

            nome

            string

            Nome del file allegato

            is_firmato

            boolean

            Indica se l’allegato è stato firmato digitalmente

            is_marcato_temporalmente

            boolean

            Indica se l’allegato è stato marcato temporalmente

            is_segnato

            boolean

            Indica se l’allegato è stato segnato

            href_file

            string

            Link per lo scaricamento del file.


            Endpoint get-registro

            GET https://nuvola.madisoft.it/api//amministrazione-digitale/%7Btenant%7D/get-registro/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id del registro richiesto.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “registro”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.



            Oggetto allegato



            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio del registro.

            nome

            string

            Nome del registro

            voce_titolario

            string

            Voce di titolario assegnata

            annotazioni

            string

            Note collegate al registro

            is_protocollato

            boolean

            Indica se il documento è stato protocollato sul registro.


            Nuvola sito web

            Base Url: https://nuvola.madisoft.it/api/sito-web

            Articoli

            Endpoints per estrarre le informazioni degli articoli

            METHOD

            ENDPOINT

            UTILIZZO

            TIPO RITORNATO

            GET

            /articoli

            Fornisce l’elenco dei documenti

            documenti

            GET

            /articolo/{id}

            Fornisce il dettaglio di un documento

            documento


            Endpoint get-articoli

            GET https://nuvola.madisoft.it/api/sito-web/%7Btenant%7D/get-articoli


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.



            Parametri query


            PARAMETRO

            OBBLIGATORIO

            VALORE

            limit

            No

            Massimo numero di artticoli da ritornare. Default: 20. Minimo: 1. Massimo: 50.

            offset

            No

            L’indice del primo articolo da ritornare. Default: 0. Usare assieme a “limit” per ottenere l’insieme successivo di articoli.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto con un campo “articoli” contenente un array di oggetti “articolo” all’interno di un oggetto “paging”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto articolo


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio dell’articolo.

            id

            string

            Id dell’articolo

            titolo

            string

            Titolo dell’articolo

            data

            datetime

            Data di pubblicazione dell’articolo

            redattore

            string

            Redattore dell’articolo


            Oggetto paging


            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio della richiesta.

            items

            array di oggetti

            I dati richiesti

            limit

            integer

            Massimo numero di items nella response

            next

            string

            Link alla pagina successiva di items (null se non presenti)

            offset

            integer

            Posizione del primo elemento ritornato

            previous

            string

            Link alla pagina precedente di items (null se non presenti)

            totale

            integer

            Numero totale di items da ritornare.


            Endpoint get-articolo

            GET https://nuvola.madisoft.it/api/sito-web/%7Btenant%7D/get-articolo/%7Bid}


            Parametri Request


            Parametri header


            PARAMETRO

            OBBLIGATORIO

            VALORE

            token

            Un token di accesso valido ottenuto dal servizio di autenticazione


            Parametri path


            PARAMETRO

            OBBLIGATORIO

            VALORE

            tenant

            L’id del cliente.

            id

            L’id dell’articolo richiesto.


            Formato Response

            In caso di successo, il codice di stato HTTP dell’header della Response è 200 e il corpo della Response consiste in un oggetto di tipo “articolo”.

            In caso di errore, il codice di stato HTTP dell’header della Response è un codice di errore e il corpo della response contiene un oggetto “error”.


            Oggetto articolo



            KEY

            TIPO

            DESCRIZIONE

            href

            string

            Link all’endpoint che ritorna il dettaglio dell’articolo.

            id

            string

            Id dell’articolo

            titolo

            string

            Titolo dell’articolo

            data

            datetime

            Data di pubblicazione dell’articolo

            redattore

            string

            Redattore dell’articolo

            contenuto

            string

            Testo dell’articolo


            Aggiornati: 28 Aug 2019 05:56 PM
            È stato di aiuto?  
            Aiutaci a migliorare questo articolo
            0 0