Web Service: AbokWSService

Target Namespace:
http://cnb.cz/abokws
Description:
Webová služba aplikace ABO-K. Webová služba poskytuje základní operace pro předávání dávek platebních příkazů, stahování protokolů a výpisů klienta. Jako transportní protokol slouží protokol https s povinnou klientskou autentizací s použitím certifikátů registrovaných v aplikaci ABO-K pro přístup. Pro uživatele je rovněž přístupná testovací verze.

Port AbokWSPort Port typeSource code

Location(TEST):
do 30.11.2017 https://aboktest.cnb.cz/abokws1.0/abokws1.0Port
od 30.9.2017 https://aboktest.cnb.cz:4001/abokws1.0/abokws1.0Port
Location(PROVOZ):
do 30.11.2017 https://abok.cnb.cz/abokws1.0/abokws1.0Port
od 2.10.2017 https://abok.cnb.cz:4001/abokws1.0/abokws1.0Port
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. getProtokolDetailSource code
  2. getVypisDetailSource code
  3. loadDavkaDetailSource code

Operations

    Port type AbokWSSource code

    1. getProtokol
      Source code
      Description:
      Slouží pro stažení protokolu v textovém a csv formátu (tj. FP5) k zadané dávce. Vlastní protokol je předáván buď přímo v elementu typu "base64Binary" a nebo jako příloha (MTOM attachment).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getProtokol
      Input:
      getProtokol (soap:body, use = literal)Source code
      parameters type getProtokol
      Output:
      getProtokolResponse (soap:body, use = literal)Source code
      parameters type getProtokolResponse
      Fault:
      AbokWSDavkaNeexException (soap:fault, use = literal)Source code
      fault type AbokWSDavkaNeexException
      Fault:
      AbokWSDavkaNotYetException (soap:fault, use = literal)Source code
      fault type AbokWSDavkaNotYetException
      Fault:
      AbokWSPrihlaseniException (soap:fault, use = literal)Source code
      fault type AbokWSPrihlaseniException
      Fault:
      AbokWSException (soap:fault, use = literal)Source code
      fault type AbokWSException
    2. getVypis
      Source code
      Description:
      Slouží pro stažení dávky výpisů pro požadovaný účetní den v textovém formátu FVx. Vlastní výpis je předáván buď přímo v elementu typu "base64Binary" a nebo jako příloha (MTOM attachment).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      getVypis
      Input:
      getVypis (soap:body, use = literal)Source code
      parameters type getVypis
      Output:
      getVypisResponse (soap:body, use = literal)Source code
      parameters type getVypisResponse
      Fault:
      AbokWSVypisNotYetException (soap:fault, use = literal)Source code
      fault type AbokWSVypisNotYetException
      Fault:
      AbokWSVypisNeexException (soap:fault, use = literal)Source code
      fault type AbokWSVypisNeexException
      Fault:
      AbokWSPrihlaseniException (soap:fault, use = literal)Source code
      fault type AbokWSPrihlaseniException
      Fault:
      AbokWSException (soap:fault, use = literal)Source code
      fault type AbokWSException
    3. loadDavka
      Source code
      Description:
      Slouží pro registraci a předání dávky platebních příkazů ve formátech FS5, FS4, FS2, FXM do ABOK. V případě úspěchu vrací hodnotu "OK", jinak vrací chybu ve formě elementu Fault.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      loadDavka
      Input:
      loadDavka (soap:body, use = literal)Source code
      parameters type loadDavka
      Output:
      loadDavkaResponse (soap:body, use = literal)Source code
      parameters type loadDavkaResponse
      Fault:
      AbokWSDavkaExistException (soap:fault, use = literal)Source code
      fault type AbokWSDavkaExistException
      Fault:
      AbokWSPrihlaseniException (soap:fault, use = literal)Source code
      fault type AbokWSPrihlaseniException
      Fault:
      AbokWSException (soap:fault, use = literal)Source code
      fault type AbokWSException

WSDL source code

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="wsdl-viewer.xsl" ?>
<definitions targetNamespace="http://cnb.cz/abokws" name="AbokWSService" xmlns="http://schemas.xmlsoap.org/wsdl/">
<types>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:import namespace="http://cnb.cz/abokws" schemaLocation="abokws1.0.xsd" />
</xsd:schema>
</types>
<message name="getVypis">
<part name="parameters" element="tns:getVypis" />
</message>
<message name="getVypisResponse">
<part name="parameters" element="tns:getVypisResponse" />
</message>
<message name="AbokWSVypisNotYetException">
<documentation>Zpráva pokud výpisy ještě nejsou vytvořeny/přítomny v ABO-K.</documentation>
<part name="fault" element="tns:AbokWSVypisNotYetException" />
</message>
<message name="AbokWSVypisNeexException">
<documentation>Zpráva pokud klient nemá pro požadovaný den žádné výpisy.</documentation>
<part name="fault" element="tns:AbokWSVypisNeexException" />
</message>
<message name="AbokWSPrihlaseniException">
<documentation>Zpráva v případě chyby přihlášení do ABO-K.</documentation>
<part name="fault" element="tns:AbokWSPrihlaseniException" />
</message>
<message name="AbokWSException">
<documentation>Ostatní aplikační výjimky.</documentation>
<part name="fault" element="tns:AbokWSException" />
</message>
<message name="getProtokol">
<part name="parameters" element="tns:getProtokol" />
</message>
<message name="getProtokolResponse">
<part name="parameters" element="tns:getProtokolResponse" />
</message>
<message name="AbokWSDavkaNeexException">
<documentation>Zpráva v případě neexistence dávky.</documentation>
<part name="fault" element="tns:AbokWSDavkaNeexException" />
</message>
<message name="AbokWSDavkaNotYetException">
<documentation>Zpráva pokud k požadované dávce není ještě protokol.</documentation>
<part name="fault" element="tns:AbokWSDavkaNotYetException" />
</message>
<message name="loadDavka">
<part name="parameters" element="tns:loadDavka" />
</message>
<message name="loadDavkaResponse">
<part name="parameters" element="tns:loadDavkaResponse" />
</message>
<message name="AbokWSDavkaExistException">
<documentation>Zpráva pokud registrovaná dávka v ABOK již existuje.</documentation>
<part name="fault" element="tns:AbokWSDavkaExistException" />
</message>
<portType name="AbokWS">
<operation name="getVypis">
<documentation>Slouží pro stažení dávky výpisů pro požadovaný účetní den v textovém formátu FVx. Vlastní výpis je předáván buď přímo v elementu typu "base64Binary" a nebo jako příloha (MTOM attachment).</documentation>
<input message="tns:getVypis" />
<output message="tns:getVypisResponse" />
<fault message="tns:AbokWSVypisNotYetException" name="AbokWSVypisNotYetException" />
<fault message="tns:AbokWSVypisNeexException" name="AbokWSVypisNeexException" />
<fault message="tns:AbokWSPrihlaseniException" name="AbokWSPrihlaseniException" />
<fault message="tns:AbokWSException" name="AbokWSException" />
</operation>
<operation name="getProtokol">
<documentation>Slouží pro stažení protokolu v textovém a csv formátu (tj. FP5) k zadané dávce. Vlastní protokol je předáván buď přímo v elementu typu "base64Binary" a nebo jako příloha (MTOM attachment).</documentation>
<input message="tns:getProtokol" />
<output message="tns:getProtokolResponse" />
<fault message="tns:AbokWSDavkaNeexException" name="AbokWSDavkaNeexException" />
<fault message="tns:AbokWSDavkaNotYetException" name="AbokWSDavkaNotYetException" />
<fault message="tns:AbokWSPrihlaseniException" name="AbokWSPrihlaseniException" />
<fault message="tns:AbokWSException" name="AbokWSException" />
</operation>
<operation name="loadDavka">
<documentation>Slouží pro registraci a předání dávky platebních příkazů ve formátech FS5, FS4, FS2, FXM do ABOK. V případě úspěchu vrací hodnotu "OK", jinak vrací chybu ve formě elementu Fault.</documentation>
<input message="tns:loadDavka" />
<output message="tns:loadDavkaResponse" />
<fault message="tns:AbokWSDavkaExistException" name="AbokWSDavkaExistException" />
<fault message="tns:AbokWSPrihlaseniException" name="AbokWSPrihlaseniException" />
<fault message="tns:AbokWSException" name="AbokWSException" />
</operation>
</portType>
<binding name="AbokWSPortBinding" type="tns:AbokWS">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
<operation name="getVypis">
<soap:operation soapAction="getVypis" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
<input>
<soap:body use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</input>
<output>
<soap:body use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</output>
<fault name="AbokWSVypisNotYetException">
<soap:fault name="AbokWSVypisNotYetException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSVypisNeexException">
<soap:fault name="AbokWSVypisNeexException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSPrihlaseniException">
<soap:fault name="AbokWSPrihlaseniException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSException">
<soap:fault name="AbokWSException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
</operation>
<operation name="getProtokol">
<soap:operation soapAction="getProtokol" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
<input>
<soap:body use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</input>
<output>
<soap:body use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</output>
<fault name="AbokWSDavkaNeexException">
<soap:fault name="AbokWSDavkaNeexException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSDavkaNotYetException">
<soap:fault name="AbokWSDavkaNotYetException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSPrihlaseniException">
<soap:fault name="AbokWSPrihlaseniException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSException">
<soap:fault name="AbokWSException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
</operation>
<operation name="loadDavka">
<soap:operation soapAction="loadDavka" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
<input>
<soap:body use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</input>
<output>
<soap:body use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</output>
<fault name="AbokWSDavkaExistException">
<soap:fault name="AbokWSDavkaExistException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSPrihlaseniException">
<soap:fault name="AbokWSPrihlaseniException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
<fault name="AbokWSException">
<soap:fault name="AbokWSException" use="literal" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</fault>
</operation>
</binding>
<service name="AbokWSService">
<documentation> Webová služba aplikace ABO-K. Webová služba poskytuje základní operace pro předávání dávek platebních příkazů, stahování protokolů a výpisů klienta. Jako transportní protokol slouží protokol https s povinnou klientskou autentizací s použitím certifikátů registrovaných v aplikaci ABO-K pro přístup. Testovací verze je přístupná na URL https://abok.cnb.cz/abokws1.0_test/abokws1.0Port</documentation>
<port name="AbokWSPort" binding="tns:AbokWSPortBinding">
<soap:address location="https://abok.cnb.cz/abokws1.0_test/abokws1.0Port" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" />
</port>
</service>
</definitions>

Imported Schema abokws1.0.xsd

<xs:schema version="1.0" targetNamespace="http://cnb.cz/abokws" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="AbokWSDavkaExistException" type="tns:AbokWSDavkaExistException" />
<xs:element name="AbokWSDavkaNeexException" type="tns:AbokWSDavkaNeexException" />
<xs:element name="AbokWSDavkaNotYetException" type="tns:AbokWSDavkaNotYetException" />
<xs:element name="AbokWSException" type="tns:AbokWSException" />
<xs:element name="AbokWSPrihlaseniException" type="tns:AbokWSPrihlaseniException" />
<xs:element name="AbokWSVypisNeexException" type="tns:AbokWSVypisNeexException" />
<xs:element name="AbokWSVypisNotYetException" type="tns:AbokWSVypisNotYetException" />
<xs:element name="getProtokol" type="tns:getProtokol" />
<xs:element name="getProtokolResponse" type="tns:getProtokolResponse" />
<xs:element name="getVypis" type="tns:getVypis" />
<xs:element name="getVypisResponse" type="tns:getVypisResponse" />
<xs:element name="loadDavka" type="tns:loadDavka" />
<xs:element name="loadDavkaResponse" type="tns:loadDavkaResponse" />
<xs:complexType name="loadDavka">
<xs:sequence>
<xs:element name="loadDavkaParam" type="tns:LoadDavkaParam" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="LoadDavkaParam">
<xs:sequence>
<xs:element name="davkaId" type="tns:DavkaId" />
<xs:element name="davka" type="xs:base64Binary" />
<xs:element name="podpis1" type="xs:base64Binary" />
<xs:element name="podpis2" type="xs:base64Binary" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="DavkaId">
<xs:sequence>
<xs:element name="idKlienta" type="xs:string" />
<xs:element name="datum" type="xs:date" />
<xs:element name="cislo" type="xs:decimal" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="loadDavkaResponse">
<xs:sequence>
<xs:element name="return" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AbokWSDavkaExistException">
<xs:sequence>
<xs:element name="message" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AbokWSPrihlaseniException">
<xs:sequence>
<xs:element name="message" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AbokWSException">
<xs:sequence>
<xs:element name="message" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="getVypis">
<xs:sequence>
<xs:element name="vypisId" type="tns:VypisId" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="VypisId">
<xs:sequence>
<xs:element name="datum" type="xs:date" />
<xs:element name="rezim" type="tns:rezimType" />
<xs:element name="idKlienta" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="getVypisResponse">
<xs:sequence>
<xs:element name="vypis" type="tns:Vypis" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="Vypis">
<xs:sequence>
<xs:element name="vypis" type="xs:base64Binary" />
<xs:element name="znacka" type="xs:base64Binary" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AbokWSVypisNotYetException">
<xs:sequence>
<xs:element name="message" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AbokWSVypisNeexException">
<xs:sequence>
<xs:element name="message" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="getProtokol">
<xs:sequence>
<xs:element name="davkaId" type="tns:DavkaId" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="getProtokolResponse">
<xs:sequence>
<xs:element name="protokol" type="tns:Protokol" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="Protokol">
<xs:sequence>
<xs:element name="stavDavky" type="xs:string" />
<xs:element name="pocetChyb" type="xs:decimal" minOccurs="0" />
<xs:element name="protokoltxt" type="xs:base64Binary" />
<xs:element name="protokolcsv" type="xs:base64Binary" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AbokWSDavkaNeexException">
<xs:sequence>
<xs:element name="message" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AbokWSDavkaNotYetException">
<xs:sequence>
<xs:element name="message" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:simpleType name="rezimType">
<xs:restriction base="xs:string">
<xs:enumeration value="B" />
<xs:enumeration value="D" />
</xs:restriction>
</xs:simpleType>
</xs:schema>

About wsdl-viewer.xsl

This document was generated by Transformiix XSLT engine. The engine processed the WSDL in XSLT 1.0 compliant mode.
This page has been generated by wsdl-viewer.xsl, version 3.1.01
Author: tomi vanek
Download at http://tomi.vanek.sk/xml/wsdl-viewer.xsl.

The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT