Dettaglio della modulistica¶
Per monitorare lo stato di avanzamento di una procedura e in particolare ottenere informazioni quali:
- Elenco modulistica documentale con relativi Identificativi
- Informazioni sulla necessaria (oppure avvenuta) Controfirma da parte dell'operatore
- Per ciascun documento quali utenti necessitano ancora di apporre la firma digitale
Basterà chiamare l'API:
/api/v2/procedures/documentsRestituisce i documenti richiesti per una procedura specifica e le informazioni relative allo stato di firma di ogni documento
Richiede autenticazione (token Bearer).
Parametri¶
| Nome | Posizione | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|---|
procedureId |
query | integer (int32) | No |
Risposte¶
| Codice | Descrizione |
|---|---|
200 |
Success |
401 |
Unauthorized |
403 |
Forbidden |
Risposta 200 · SignDocumentOIEnumerableLsWebResponse
{
"error": {
"httpStatusCode": 100,
"level": 0,
"levelName": "string",
"message": "string",
"stackTrace": "string",
"exceptionMessage": "string"
},
"response": {
"level": 0,
"levelName": "string",
"message": "string",
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"counterSignable": true,
"counterSigned": true,
"name": "string",
"signers": [
{
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"signed": true
}
]
}
]
}
}
La risposta alla chiamata restituirà un array di documenti identificati con un GUID nel campo id, un campo name che indica il nome del documento da firmare e due booleani counterSignable(true se per quel documento è, o è stata, necessaria la controfirma) e counterSigned(true se è stato controfirmato con successo), infine signers un array di un oggetto contenente userId id dell'utente (o Operatore) che deve controfirmare il documento, un campo signed booleano che indica l'apposizione della firma e un campo name relativo all'utente.
Se la procedura è in stato "Completed", l'utente può richiedere i singoli file mediante una singola chiamata, indicando per ciacun file il corrispettivo identificativo GUID recuperato dalla chiamata precedentemente effettuata:
/api/v2/file/document/registeredPermette di scaricare i template già compilati
Richiede autenticazione (token Bearer).
Parametri¶
| Nome | Posizione | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|---|
guid |
query | string | No |
Risposte¶
| Codice | Descrizione |
|---|---|
200 |
Success |
401 |
Unauthorized |
403 |
Forbidden |
Risposta 200 · FileOLsWebResponse
Oppure, se lo preferisce, può scaricare un archivio ZIP che comprende tutti i documenti della procedura indicata tramite quest'altra API:
/api/v2/file/document/registered/bulkRichiede autenticazione (token Bearer).
Parametri¶
| Nome | Posizione | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|---|
procedureId |
query | integer (int32) | No |
Risposte¶
| Codice | Descrizione |
|---|---|
200 |
Success |
401 |
Unauthorized |
403 |
Forbidden |
Risposta 200 · FileOLsWebResponse
Warning
ATTENZIONE: I file scaricati singolarmente o mediante ZIP, presenteranno un fileName interpolato con l'id della procedura a cui fa riferimento.
Es.: Il file relativo al documento con filename: "Informativa.pdf" presenterà al momento del download un filename così strutturato: "<Id procedura>_<Filename>".