The Preserve_getForUpdate method

Allows to get details of preserved documents that need an extension before the validity of their electronic signature, electronic seal or time stamp expires.

Service description including WSDL schema and ann example request and response for SOAP 1.1 and SOAP 1.2 are located at https://localhost/secusign/default.asmx?op=Preserve_getForUpdate.

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_getForUpdate"
<?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_getForUpdate xmlns="http://software602.com/secusign/">
      <ExpirationLimit>dateTime</ExpirationLimit>
      <SortInfoMask>string</SortInfoMask>
      <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>
      <MaxResCount>int</MaxResCount>
      <Offset>integer</Offset>
      <Params>string</Params>
    </Preserve_getForUpdate>
  </soap:Body>
</soap:Envelope>

Input parameters of the method

<ExpirationLimit>

[mandatory element]

Input Description

dateTime

Date and time as of to look up preserved electronic signatures in documents that need to be extended.

<SortInfoMask>

[optional element]

Input Description

string

Specifies the name of a sorting folder or structure of nested folders (E.g., /FA/2017/02) from which details of preserved electronic signatures in documents will be returned.

Max. 100 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

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).

<MaxResCount>

[mandatory element]

Input Description

Int

Maximum number of results to return.

<Offset>

[mandatory element]

Input Description

Int

Pagination of returned DocIDs. The value sets the number of IDs where to start from when returning additional results.

<Params>

[optional element]

Input Description

String

Optional, contains other parameters. Not in use yet.

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_getForUpdateResponse xmlns="http://software602.com/secusign/">
      <Preserve_getForUpdateResult>int</Preserve_getForUpdateResult>
      <DocIDs>
        <string>string</string>
        <string>string</string>
      </DocIDs>
      <StatusMessage>string</StatusMessage>
    </Preserve_getForUpdateResponse>
  </soap:Body>
</soap:Envelope>

Output parameters of the method

<Preserve_getForUpdateResult>

Return value Description

int

Result of the Preserve_getForUpdateResult method. 0 = OK, otherwise see Return codes of all methods and error described in StatusMessage.

<DocIDs>

<String>

Repeating element if there is more than one document.

Return value Description

String

List of identifiers for documents with preserved signatures registered for the submitted ExpirationLimit. Max. 128 characters.

</DocIDs>

<StatusMessage>

Return value Description

String

Text statement corresponding to the overall result of getting information for preserved documents with electronic signatures that need to be extended in the SecuSign service. The value is only filled if the result is complicated.