Metoda Preserve_update
Umožňuje prodloužit platnost uchovaných podpisů v dokumentu přidáním dalšího kvalifikovaného časového razítka a revokačních dat – informací souvisejících s ověřením podpisu jako jsou odpovědi OCSP/CRL na všechny certifikáty v řetězci, tj. od podpisového certifikátu ke kořenovému certifikátu vystavitele (certifikační autority), díky čemuž se zajistí jejich další ověřitelnost.
Popis služby včetně WSDL schématu a příklad požadavku a odpovědi pro SOAP 1.1 a SOAP 1.2 je umístěn na https://localhost/secusign/default.asmx?op=Preserve_update.
Localhost je název používaný pro lokální počítač; namísto něj zvolte jméno/IP adresu SDK serveru (dle nastavení v IIS). |
Požadavek v rozhraní SOAP 1.1
POST /secusign/default.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/secusign/Preserve_update"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Preserve_update xmlns="http://software602.com/secusign/">
<DocID>string</DocID>
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<FileType>UNKNOWN or CMSPKCS7 or CMSPKCS7Ext or PDF or XML or XML602FORM or XMLISDOC or ASiC_S_CAdES or ASiC_S_XAdES or ASiC_S_Tst or ASiC_E_CAdES_Tst or ASiC_E_XAdES or MS_WORD or MS_EXCEL or MS_PWR_PNT or ODF</FileType>
<ExternalSignatureFileName>string</ExternalSignatureFileName>
<ExternalSignature>base64Binary</ExternalSignature>
<SortInfo>string</SortInfo>
<UserComment>string</UserComment>
<Params>string</Params>
</Preserve_update>
</soap:Body>
</soap:Envelope>
Vstupní parametry metody
<DocID>
[povinný element]
Vstup | Popis |
---|---|
string |
Jednoznačné identifikační číslo uchovaných elektronických podpisů v dokumentu. Bylo automaticky vygenerováno při procesu uchování ve službě SecuSign. Lze jej najít v uživatelském rozhraní účtu. Max. 128 znaků. |
<FileName>
[povinný element]
Vstup | Popis |
---|---|
String |
Název vstupního souboru (včetně přípony) pro uchování elektronických podpisů. Příklad: Dokument.pdf. Max. 260 znaků. |
<FileType>
[povinný element]
Vstup | Popis |
---|---|
UNKNOWN |
Neznámý typ dokumentu. |
CMSPKCS7 |
Dokument podepsaný interním CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
CMSPKCS7Ext |
Dokument podepsaný externím CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
Podepsaný PDF dokument. |
|
XML |
Podepsaná XML data. |
XML602FORM |
FO/ZFO formuláře aplikace Software602 Form Filler. |
XMLISDOC |
Podepsaná XML ISDOC data. |
ASiC_S_CAdES |
ASiC-Simple s CAdES podpisem. |
ASiC_S_XAdES |
ASiC-Simple s XAdES podpisem. |
ASiC_S_Tst |
ASiC-Simple s Timestamp. |
ASiC_E_CAdES_Tst |
ASiC-Extended s CAdES podpisem nebo s Timestamp. |
ASiC_E_XAdES |
ASiC-Extended s XAdES podpisem. |
MS_WORD |
Dokument aplikace MS Word. |
MS_EXCEL |
Dokument aplikace MS Excel. |
MS_PWR_PNT |
Dokument aplikace MS Powerpoint. |
ODF |
Podepsaný OpenDocumentFormat (OpenOffice). |
<ExternalSignatureFileName>
[nepovinný element]
Vstup | Popis |
---|---|
string |
Název souboru externího podpisu. Pouze v případě, že k dokumentu byl takový podpis vytvořen. |
<ExternalSignature>
[nepovinný element]
Vstup | Popis |
---|---|
Base64Binary |
Data externího podpisu kódovaná v base64. Pouze v případě, že k dokumentu byl takový podpis vytvořen. |
<SortInfo>
[nepovinný element]
Vstup | Popis |
---|---|
String |
Zatřiďovací informace – např. název složky, nebo struktura vnořených složek, ve kterých je dokument u uživatele evidován. Max. 100 znaků. |
Struktura odpovědi na požadavek
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Preserve_updateResponse xmlns="http://software602.com/secusign/">
<Preserve_updateResult>int</Preserve_updateResult>
<OutputData>base64Binary</OutputData>
<PreservationInfo>
<CreationDateTime>dateTime</CreationDateTime>
<docId>string</docId>
<fileName>string</fileName>
<fileSize>long</fileSize>
<sortInfo>string</sortInfo>
<lastUpdate>dateTime</lastUpdate>
<expiration>dateTime</expiration>
<docDataHash>base64Binary</docDataHash>
<docDataHashAlg>string</docDataHashAlg>
<currSignHashAlg>string</currSignHashAlg>
<sigValidityCondition>ALL or AT_LEAST_ONE or LAST</sigValidityCondition>
<sigsPreservationStatus>
<PreservationInfo>
<sid>string</sid>
<sigStatus xsi:nil="true" />
<extendedValidationEndDate>dateTime</extendedValidationEndDate>
<signingCertSubject>string</signingCertSubject>
<bIsDocTimeStamp>boolean</bIsDocTimeStamp>
<procesStatus>string</procesStatus>
</PreservationInfo>
<PreservationInfo>
<sid>string</sid>
<sigStatus xsi:nil="true" />
<extendedValidationEndDate>dateTime</extendedValidationEndDate>
<signingCertSubject>string</signingCertSubject>
<bIsDocTimeStamp>boolean</bIsDocTimeStamp>
<procesStatus>string</procesStatus>
</PreservationInfo>
</sigsPreservationStatus>
<preservationHistory>
<PreservationRecord>
<id>int</id>
<operationTime>dateTime</operationTime>
<operationType>REGISTER or UPDATE or UNREGISTER or UNKNOWN</operationType>
<operationStatus>int</operationStatus>
<operationStatusInfo>string</operationStatusInfo>
<fileName>string</fileName>
<fileSize>long</fileSize>
<hashIn>string</hashIn>
<hashOut>string</hashOut>
<userComment>string</userComment>
</PreservationRecord>
<PreservationRecord>
<id>int</id>
<operationTime>dateTime</operationTime>
<operationType>REGISTER or UPDATE or UNREGISTER or UNKNOWN</operationType>
<operationStatus>int</operationStatus>
<operationStatusInfo>string</operationStatusInfo>
<fileName>string</fileName>
<fileSize>long</fileSize>
<hashIn>string</hashIn>
<hashOut>string</hashOut>
<userComment>string</userComment>
</PreservationRecord>
</preservationHistory>
<docType>string</docType>
</PreservationInfo>
<StatusMessage>string</StatusMessage>
</Preserve_updateResponse>
</soap:Body>
</soap:Envelope>
Výstupní parametry metody
<Preserve_updateResult>
Návratová hodnota | Popis |
---|---|
Int |
Výsledek metody Preserve_update (ošetření dokumentu s elektronickými podpisy). 0 = v pořádku, jinak Návratové kódy všech metod a chyba popsaná ve StatusMessage. |
<OutputData>
Návratová hodnota | Popis |
---|---|
Base64Binary |
Data uchovaného dokumentu s ošetřenými elektronickými podpisy kódována v base64. |
<Info>
<CreationDateTime>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas, kdy došlo k vytvoření reportu o uchování dokumentu s elektronickými podpisy. |
<docID>
Návratová hodnota | Popis |
---|---|
String |
Jednoznačné identifikační číslo uchovaného dokumentu s ošetřenými elektronickými podpisy. Bylo automaticky vygenerováno při procesu uchování ve službě SecuSign. Pod tímto číslem je možné v metodě Preserve_getInfo zjistit informace o uchovaném dokumentu. Max. 128 znaků. |
<fileName>
Návratová hodnota | Popis |
---|---|
String |
Název uchovaného souboru s elektronickými podpisy. Max. 260 znaků. |
<sortInfo>
Návratová hodnota | Popis |
---|---|
String |
Zatřiďovací informace – např. název složky, nebo struktura vnořených složek, ve kterých je dokument u uživatele evidován. Max. 100 znaků. |
<lastUpdate>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas posledního prodloužení platnosti a ověřitelnosti dokumentu s elektronickými podpisy. |
<expiration>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas vypršení ověřitelnosti platnosti celého dokumentu. Po tomto datu nebude možné ověřit platnost certifikátů podpisů / pečetí / razítek a zajistit další ověřitelnost a platnost uchovaného dokumentu. |
<docDataHash>
Návratová hodnota | Popis |
---|---|
Base64Binary |
Hash analyzovaného dokumentu kódovaný v Base64. Algoritmus výpočtu hashe je v následujícím elementu docDataHashAlg. |
<docDataHashAlg>
Návratová hodnota | Popis |
---|---|
String |
Algoritmus výpočtu hashe analyzovaného dokumentu. Ve tvaru například: 2.16.840.1.101.3.4.2.1. |
<currSignHashAlg>
Návratová hodnota | Popis |
---|---|
String |
Algoritmus výpočtu hashe posledního podpisu. Příklad: 2.16.840.1.101.3.4.2.1. |
<sigValidityCondition>
Návratová hodnota | Popis |
---|---|
String |
Podmínky platnosti podpisu pro další uchování. Hodnoty: ALL – všechny podpisy jsou platné. AT_LEAST_ONE – alespoň jeden podpis je platný. LAST – poslední podpis je platný. |
<sigsPreservationStatus>
<sid>
Návratová hodnota | Popis |
---|---|
String |
Identifikátor podpisu, který k danému uchovanému dokumentu eviduje služba SecuSign. |
<subindication>
Návratová hodnota | Popis |
---|---|
string |
Podstav ověření podpisu – subindikace. Nabývá hodnot (odpovídajících normě ETSI[2]):
|
</sigStatus>
<extendedValidationEndDate>
Návratová hodnota | Popis |
---|---|
dateTime |
Datum a čas, do kdy byla prodloužena ověřitelnost podpisu. |
<signingCertSubject>
Návratová hodnota | Popis |
---|---|
string |
Identifikace podpisového certifikátu, který byl ošetřen. |
<bISDocTimeStamp>
Návratová hodnota | Popis |
---|---|
boolean |
Určuje, zda podpis je samostatným časovým razítkem. |
<procesStatus>
Návratová hodnota | Popis |
---|---|
string |
Stav ošetření podpisu při uchování. Hodnoty:
|
</PreservationInfo>
</sigsPreservationStatus>
<preservationHistory>
<operationType>
Návratová hodnota | Popis |
---|---|
PreserveOperation |
Typ provedené operace. Hodnoty:
|
<operationStatusInfo>
Návratová hodnota | Popis |
---|---|
string |
Textová zpráva odpovídající stavu provedení operace. |
<docType>
Návratová hodnota | Popis |
---|---|
UNKNOWN |
Neznámý typ dokumentu. |
CMSPKCS7 |
Dokument podepsaný interním CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
CMSPKCS7Ext |
Dokument podepsaný externím CMS/PKCS7 podpisem např.: Datové zprávy z Informačního systému datových schránek. |
Podepsaný PDF dokument. |
|
XML |
Podepsaná XML data. |
XML602FORM |
FO/ZFO formuláře aplikace Software602 Form Filler. |
XMLISDOC |
Podepsaná XML ISDOC data. |
ASiC_S_CAdES |
ASiC-Simple s CAdES podpisem. |
ASiC_S_XAdES |
ASiC-Simple s XAdES podpisem. |
ASiC_S_Tst |
ASiC-Simple s Timestamp. |
ASiC_E_CAdES_Tst |
ASiC-Extended s CAdES podpisem nebo s Timestamp. |
ASiC_E_XAdES |
ASiC-Extended s XAdES podpisem. |
MS_WORD |
Podepsaný dokument aplikace MS Word. |
MS_EXCEL |
Podepsaný dokument aplikace MS Excel. |
MS_PWR_PNT |
Podepsaný dokument aplikace MS Powerpoint. |
ODF |
Podepsaný OpenDocumentFormat (OpenOffice). |
</PreservationInfo>