The Preserve_update method
Allows validity extension for preserved signatures in the document by adding another qualified time stamp and revocation data - data related to signature validation, as OCSP/CRL responses to all certificates in the chain, i.e., from the signature certificate to the root certificate of the issuer (certification authority), to ensure they will be validable in the future.
Service description including WSDL schema, and an example request and response for SOAP 1.1 and SOAP 1.2 are located at https://localhost/secusign/default.asmx?op=Preserve_update.
Localhost is the name used for the local computer; write the SDK server name/IP address instead (according to the settings in IIS). |
Request in SOAP 1.1 interface
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>
Input parameters of the method
<DocID>
[mandatory element]
Input | Description |
---|---|
string |
Unique identifier of the preserved electronic signatures in a document. It was generated automatically during the preservation process in the SecuSign service. Can be found in the account’s user interface. Max. 128 characters. |
<FileName>
[mandatory element]
Input | Description |
---|---|
String |
Name of input file (including extension) for electronic signature preservation. Example: Document.pdf. Max. 260 characters. |
<FileType>
[mandatory element]
Input | Description |
---|---|
UNKNOWN |
Unknown document type |
CMSPKCS7 |
Document signed with an internal CMS/PKCS7 signature, e.g. Data messages from the Data Mailbox Information System. |
CMSPKCS7Ext |
Document signed with an external CMS/PKCS7 signature, e.g. Data messages from the Data Mailbox Information System. |
PDF document. |
|
XML |
XML data. |
XML602FORM |
FO/ZFO forms for Software602 Form Filler. |
XMLISDOC |
Signed XML ISDOC data. |
ASiC_S_CAdES |
ASiC-Simple with CAdES signature. |
ASiC_S_XAdES |
ASiC-Simple with XAdES signature. |
ASiC_S_Tst |
ASiC-Simple with Timestamp. |
ASiC_E_CAdES_Tst |
ASiC-Extended with CAdES signature or Timestamp. |
ASiC_E_XAdES |
ASiC-Extended with XAdES signature. |
MS_WORD |
MS Word document. |
MS_EXCEL |
MS Excel document. |
MS_PWR_PNT |
MS PowerPoint document. |
ODF |
Signed OpenDocumentFormat (OpenOffice). |
<ExternalSignatureFileName>
[optional element]
Input | Description |
---|---|
string |
External signature file name. Only if such a signature has been created for the document. |
<ExternalSignature>
[optional element]
Input | Description |
---|---|
Base64Binary |
External signature data encoded in base64. Only if such a signature has been created for the document. |
<SortInfo>
[optional element]
Input | Description |
---|---|
String |
Sorting details – e.g., folder name or structure of nested folders in which the document is registered with the user. Max. 100 characters. |
Response structure
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>
Output parameters of the method
<Preserve_updateResult>
Return value | Description |
---|---|
Int |
Result of the Preserve_update method (treatment of a document with electronic signatures). 0 = OK, otherwise see Return codes of all methods and error described in StatusMessage. |
<OutputData>
Return value | Description |
---|---|
Base64Binary |
Data of the preserved document with treated electronic signatures encoded in base64. |
<Info>
<CreationDateTime>
Return value | Description |
---|---|
dateTime |
Date and time of creating the report on preserving a document with electronic signatures. |
<docID>
Return value | Description |
---|---|
string |
Unique identifier of the preserved document with treated electronic signatures. It was generated automatically during the preservation process in the SecuSign service. This identifier can be used with the Preserve_getInfo method to get details of the preserved document. Max. 128 characters. |
<fileName>
Return value | Description |
---|---|
string |
Name of the preserved document with electronic signatures. Max. 260 characters. |
<sortInfo>
Return value | Description |
---|---|
string |
Sorting details – e.g., folder name or structure of nested folders in which the document is registered with the user. Max. 100 characters. |
<lastUpdate>
Return value | Description |
---|---|
dateTime |
Date and time of the last validity and validability extension for the document with electronic signatures. |
<expiration>
Return value | Description |
---|---|
dateTime |
Date and time when the whole document’s validability expire. After this date it will not be possible to validate the signature certificates / seals / time stamps and provide further validability and validity of the document. |
<docDataHash>
Return value | Description |
---|---|
Base64Binary |
Hash of the analyzed document encoded in Base64. The hash calculation algorithm is in the following docDataHashAlg element. |
<docDataHashAlg>
Return value | Description |
---|---|
string |
The hash calculation algorithm for the analyzed document. The format is e.g.: 2.16.840.1.101.3.4.2.1. |
<currSignHashAlg>
Return value | Description |
---|---|
string |
The hash calculation algorithm of the last signature. Example: 2.16.840.1.101.3.4.2.1. |
<sigValidityCondition>
Return value | Description |
---|---|
string |
Signature validity conditions for further preservation. Values:
|
<sigsPreservationStatus>
<sid>
Return value | Description |
---|---|
string |
Identifier of the signature registered for the document by the SecuSign service. |
<subindication>
Return value | Description |
---|---|
string |
Signature validation substatus - subindication. It may be one of the following values (According to the ETSI standard [2]):
|
</sigStatus>
<extendedValidationEndDate>
Return value | Description |
---|---|
dateTime |
Date and time until when the signature validability were extended. |
<bISDocTimeStamp>
Return value | Description |
---|---|
boolean |
Specifies whether the signature is a standalone time stamp. |
<procesStatus>
Return value | Description |
---|---|
string |
Signature treatment status at the time of preservation. Values:
|
</PreservationInfo>
</sigsPreservationStatus>
<preservationHistory>
<operationType>
Return value | Description |
---|---|
|
Type of operation performed. Values: * REGISTER – preservation of a document with electronic signatures. * UPDATE – validity and validability extension for a document’s electronic signatures. * UNREGISTER – removal of a document from preservation in the SecuSign service. * UNKNOWN – unknown operation type. |
<operationStatusInfo>
Return value | Description |
---|---|
string |
Text statement corresponding to the operation status. |
<docType>
Return value | Description |
---|---|
UNKNOWN |
Unknown document type |
CMSPKCS7 |
Document signed with an internal CMS/PKCS7 signature, e.g. Data messages from the Data Mailbox Information System. |
CMSPKCS7Ext |
Document signed with an external CMS/PKCS7 signature, e.g. Data messages from the Data Mailbox Information System. |
Signed PDF document. |
|
XML |
Signed XML data. |
XML602FORM |
FO/ZFO forms for Software602 Form Filler. |
XMLISDOC |
Signed XML ISDOC data. |
ASiC_S_CAdES |
ASiC-Simple with CAdES signature. |
ASiC_S_XAdES |
ASiC-Simple with XAdES signature. |
ASiC_S_Tst |
ASiC-Simple with Timestamp. |
ASiC_E_CAdES_Tst |
ASiC-Extended with CAdES signature or Timestamp. |
ASiC_E_XAdES |
ASiC-Extended with XAdES signature. |
MS_WORD |
Signed MS Word document. |
MS_EXCEL |
Signed MS Excel document. |
MS_PWR_PNT |
Signed MS PowerPoint document. |
ODF |
Signed OpenDocumentFormat (OpenOffice). |
</PreservationInfo>