Metoda Preserve_getForUpdate

Umožňuje zjistit informace o uchovaných dokumentech, které je třeba před vypršením platnosti elektronického podpisu, elektronické pečeti a/nebo časového razítka prodloužit.

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

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_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>

Vstupní parametry metody

<ExpirationLimit>

[povinný element]

Vstup Popis

dateTime

Datum a čas, ke kterému se vyhledají uchované elektronické podpisy v dokumentech, které je nutné prodloužit.

<SortInfoMask>

[nepovinný element]

Vstup Popis

string

Definuje název zatřiďovací složky, nebo strukturu vnořených složek (Např. /FA/2017/02) ze které vrátí informace o uchovaných elektronických podpisech v dokumentech.

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

PDF

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

<MaxResCount>

[povinný element]

Vstup Popis

Int

Maximální počet výsledků, které se mají vrátit.

<Offset>

[povinný element]

Vstup Popis

Int

Stránkování vrácených DocIDs. Číslem se nastaví počet IDs, od kterých se má pokračovat ve vrácení dalších výsledků.

<Params>

[nepovinný element]

Vstup Popis

String

Volitelné, obsahuje další parametry. Zatím se nevyužívá.

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_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>

Výstupní parametry metody

<Preserve_getForUpdateResult>

Návratová hodnota Popis

int

Výsledek metody Preserve_getForUpdateResult. 0 = v pořádku, jinak Návratové kódy všech metod a chyba popsaná ve StatusMessage.

<DocIDs>

<String>

Opakující se element v případě vice dokumentů

Návratová hodnota Popis

String

Seznam identifikátorů dokumentů s uchovanými podpisy, které k poskytnutému ExpirationLimit služba eviduje.

Každý string má max. 128 znaků.

</DocIDs>

<StatusMessage>

Návratová hodnota Popis

String

Textová zpráva odpovídající celkovému výsledku zjištění informací o uchovaných dokumentech s elektronickými podpisy, které je nutné ve službě SecuSign prodloužit. Hodnota je naplněna pouze v případě problematického výsledku.