Richieste & autenticazione

DocsMarshal espone più API HTTP che si possono utilizzare per fare operazioni su profili, task, processi, workflow e documenti.
Per usare quese API è necessario essere autenticati a DocsMarshal (d'ora in poi DM), e per questo sono disponibili due metodi:

1. Login con username e password: La prima chiamata alla API deve essere verso il metodo di login, che dati una username e una password si occupa di loggare l'utente al sistema e restituire un Session ID.
   Il login scade dopo un periodo di inattività predefinito.
2. Autenticazione tramite Static Session ID (SSID): È possibile impostare un Session ID statico per un utente. In questo modo non c'è bisogno di alcuna chiamata aggiuntiva per autenticarsi.

le richieste verso la API dovranno sempre riportare il Session ID dell'utente:

{
    'SessionID': mio_sid,
            
    ...copo della richiesta
}

Risposte

Tutti i metodi della API forchè quelli nel gruppo /DMLogin ritornano una stringa JSON in questo formato:

{
    'result':
    {
        'HasError': true/false,
        'Error': 'optional error description',
        ...corpo della risposta
    }
}

HasError è un valore booleano che informa se c'è stato un errore nell'elaborazione della richiesta. Nel caso HasError abbia valore true, allora nella proprietà Error si trova una stringa che descrive l'errore.
Se invece HasError ha valore false la richiesta è andata a buon fine e nelle altre proprietà dell'oggetto si possono trovare i risultati della richiesta, se ce ne sono.

Base di DocsMarshal

In questa sezione dedicata è documentata la base di DocsMarshal.
Leggi la documentazione base

Gruppi API

Path	Descrizione
/DMDocuments/	Esegui operazioni sui documenti
/DMLogin/	Operazioni di autenticazione
/DMProfile/	Operazioni sui profili
/DMSearch/	Esegui delle ricerche sui profili
/DMWorkflow/	Esegui operazioni su workflow, processi e task
/DocumentModel/	Creazione e Download documenti
/Gantt/	Visualizza e gestisci gli aspetti di un Gantt
/Grid/	Visualizza e gestisci liste di profili, task, processi o mail
/HL7/	Utilizza connessioni HL7
/Home/	Utilizza DocsMarshal sul web
/Mail/	Visualizza e gestisci le mail
/Profile/	Form HTML per visualizzare, inserire e modificare profili
/Scheduler/	Utilizza gli scheduler configurati in DocsMarshal
/Task/	Visualizza e gestisci i task
/Tools/	App utilizzabili per visualizzare e lavorare sui dati tramite interfaccia grafica in DocsMarshal
/TreeList/	Visualizza e gestisci liste di profili attraverso una visualizzazione a griglia alberata (TreeList)
/Workflow/	Nuove API per eseguire operazioni su workflow

Activity Library e Entità

In questa sezione dedicata sono documentate le activity e le entità disponibili per lo sviluppo dei workflow.
Leggi la documentazione delle activity
Leggi la documentazione delle entità

Javascript Framework

DocsMarshal offre un framework Javascript per la creazione di interfacce grafiche complesse e per l'accesso alle API che in poche sintetiche righe di codice permettono di sfruttare la configurazione dell'impianto implementando interfacce e comportamenti dinamici.
Leggi la documentazione del framework Javascript