Název metody: ListCerts

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=ListCerts.

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/ListCerts"

<?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>
    <ListCerts xmlns="http://software602.com/secusign/">
      <Params>string</Params>
      <IncludeNotEnabled>integer</IncludeNotEnabled>
    </ListCerts>
  </soap:Body>
</soap:Envelope>

Vstupní parametry metody

<Params>

[nepovinný element]

Vstup Popis

string

Pokud nebyl uživatel autentizován k webové službě svým účtem (např. 602 ID), pak je možné specifikovat uživatele pomocí Identifikátoru uživatele (id_user) a Identifikátoru organizace (id_org).

Zápis v podobě: Id_user=Name; id_org=IdentOrgGUID.

Standardně se počítá s autentizací a identifikací 602 ID účtu uživatele.

Hodnota: <IncludeExpired>

Pokud je hodnota nastavena na false, nevrací v seznamu expirované certifikáty. Pokud se hodnota neuvede nebo je nastavena na true, vrací se i expirované certifikáty.

<IncludeNotEnabled>

[nepovinný element]

Vstup Popis

Int

Vrátí i certifikáty, které jsou ve stavu DISABLED nebo REVOKED, viz výstupní hodnoty v kapitole <Status>.

Pokud je parametr nastaven na hodnotu 1, vrací všechny certifikáty bez ohledu na jejich stav.

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>
    <ListCertsResponse xmlns="http://software602.com/secusign/">
      <ListCertsResult>int</ListCertsResult>
      <CertList>
        <PKCS11CertInfo>
          <Alias>string</Alias>
          <X509CertData>base64Binary</X509CertData>
          <Status>string</Status>
        </PKCS11CertInfo>
        <PKCS11CertInfo>
          <Alias>string</Alias>
          <X509CertData>base64Binary</X509CertData>
          <Status>string</Status>
        </PKCS11CertInfo>
      </CertList>
      <StatusMessage>string</StatusMessage>
    </ListCertsResponse>
  </soap:Body>
</soap:Envelope>

Výstupní parametry metody

<ListCertsResult>

Návratová hodnota Popis

Int

Výsledek metody ListCerts (získání seznamu certifikátů). 0 = v pořádku, jinak Návratové kódy všech metod a chyba popsaná ve StatusMessage.

<CertList>

Pole se seznamem certifikátů.

<PKCS11CertInfo>

Informace o certifikátu.

<Alias>

Návratová hodnota Popis

String

Alias neboli CertificateID uživatelského certifikátu v GUID formátu.

<X509CertData>

Návratová hodnota Popis

Base64Binary

Base64 Data certifikátu ve formátu X509.

<Status>

Návratová hodnota Popis

String

Stav uživatelského certifikátu. Hodnoty:

  • ENABLED – povolený, lze použít.

  • DISABLED – zakázaný, nelze použít.

  • REVOKED – odvolaný, nelze použít.

<StatusMessage>

Návratová hodnota Popis

String

Textová zpráva odpovídající celkovému získání seznamu certifikátů. Hodnota je naplněna pouze v případě problematického výsledku.