GetCertificateStatus

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Document Automation > Firma elettronica >

GetCertificateStatus

Restituisce lo stato ed eventuali informazioni relative a creazione, scadenza ed usabilità di un certificato di firma.

 

Metodo

PlugDocumentAutomation /GetCertificateStatus

 

 

Input

Nome

Descrizione

Tipo

Opzionale

serverAddress

Indirizzo server da un Dominio esterno (per il Dominio della sessione corrente, utilizzare nullo o vuoto).

String

Y

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

identityReference

Collegamento all'identità che deve firmare il documento.

Reference

 

transactionId

Identificativo della transazione che si sta eseguendo. Obbligatorio nel caso di certificato transazionale.

String

Y

Output

 

Nome

Descrizione

Tipo

 

returnValue

Restituisce un dato strutturato che contiene i seguenti campi:

Status, di tipo intero, che può assumere i seguenti valori:

o0 se il certificato esiste e il certificato è ancora usabile;

o1 se il certificato esiste, è valido, ma non utilizzabile per la firma;

o2 se il certificato esiste, ma non è valido nè utilizzabile;

o3 se il certificato non esiste.

StartDate, di tipo data e ora in formato UTC, indica la data di attivazione del certificato.

EndDate, di tipo data e ora in formato UTC,indica la data di scadenza del certificato;

UsabilityDate, di tipo data e ora in formato UTC,indica la data di usabilità del certificato.

StartDate, EndDate e UsabilityDate vengono valorizzati se Status è diverso dal valore 3.

DataSet

 

 

Commenti

Il metodo restituisce Status pari al valore 3, anche nel caso di certificato annullato con o senza revoca o di certificato transazionale già utilizzato nel periodo di validità.

Nel caso di Status pari al valore 1 o 2, non sarà possibile creare un nuovo certificato fino alla revoca di quello esistente non più utilizzabile. A tal fine si può utilizzare il metodo DisableAdvancedSignature.

 

Il metodo si comporta come segue:

Restituisce

Condizione

Errore

PLUG_MissingIdentificationDocument

Se l'identità referenziata in identityReference non dispone di un documento di riconoscimento.

Errore

PLUG_InvalidIdentificationCode

Se l'identità referenziata in identityReference dispone di un documento di riconoscimento scaduto.

Errore

PLUG_MissingIdentificationCode

Se l'identità referenziata in identityReference non dispone del codice del documento di riconoscimento.

Errore

PLUG_MissingEmailAddress

Se l'identità referenziata in identityReference non dispone di un indirizzo email.

Errore

PLUG_InvalidEmailAddress

Se l'identità referenziata in identityReference dispone di un indirizzo email, ma esso non è validato.

Errore

PLUG_MissingPhoneAddress

Se l'identità referenziata in identityReference non dispone di un recapito telefonico.

Errore

PLUG_InvalidPhoneAddress

Se l'identità referenziata in identityReference dispone di un recapito telefonico, ma esso non è validato.

Errore

ERR_ServiceInvocationException

Se fieldMapping riporta il nome di campi diversi dal tipo testo breve o testo lungo presenti nella risorsa referenziata da identityReference.

Errore

PLUG_Error

Se il codice riportato in secretCode non può essere utilizzato come password dell'utente per il certificato di firma.

Errore

Certificate already exists. - PLUG_Error

Se per l'identità specificata esiste già un certificato di firma con il transactionId specificato.

Errore

SecretCode must contain 8 characters. - PLUG_Error

Se il codice riportato in secretCode non contiene 8 caratteri.

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di Lettura sulla risorsa referenziata dal collegamento identityReference.