Web Service: CitizenApi

Description:
Specyfikacja API dla systemów zewnętrznych - klientów systemu KREPTD wersja 1.0
Target Namespace:
http://api.citizen.kreptd.gitd.gov.pl/v5.0

Port CitizenApiSOAP Port typeSource code

Location:
https://api.citizen.gitd.gov.pl/CitizenApi.svc
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. PobierzPrzedsiebiorceDetailSource code
  2. WyszukajPrzedsiebiorceDetailSource code

Operations

    Port type CitizenApiSource code

    1. PobierzPrzedsiebiorce
      Description:
      Pobiera szczegółowe dane przedsiębiorcy wskazanego numerem referencyjnym
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      http://api.citizen.kreptd.gitd.gov.pl/v5.0/#PobierzPrzedsiebiorce
      Input:
      PobierzPrzedsiebiorce (soap:body, use = literal)Source code
      parameters type PobierzPrzedsiebiorce
      • numerReferencyjny - nillable; type NumerReferencyjnyPrzedsiebiorcyTyp - type undefined with restriction pattern(P\/[0-9]{4}\/[0-9]{8,9})
      Output:
      PobierzPrzedsiebiorceResponse (soap:body, use = literal)Source code
      parameters type PobierzPrzedsiebiorceResponse
      • przedsiebiorcaSzczegoloweDaneWyszukane - nillable; type PrzedsiebiorcaSzczegoloweDaneWyszukaneTyp - extension of type PrzedsiebiorcaDaneWyszukaneTyp
        Struktura na dane szczegółowe o przedsiębiorcy
        Podstawowe dane przedsiębiorcy wyszukanego przez usługę
        • NumerReferencyjny - optional; type NumerReferencyjnyPrzedsiebiorcyTyp - type undefined with restriction pattern(P\/[0-9]{4}\/[0-9]{8,9})
        • FirmaNazwa type FirmaNazwaTyp - type undefined with restriction maxLength(2000)
        • NIP type NumerNIPTyp - type undefined with restriction pattern([0-9]{10})
        • FormaPrawna - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
        • ListaZarzadzajacyTransportemDaneWyszukane - optional; type ListaZarzadzajacyTransportemDaneWyszukaneTyp
          Lista dla ZarzadzajacyTransportemDaneWyszukaneTyp
          • ZarzadzajacyTransportemDaneWyszukane - optional, unbounded; type ZarzadzajacyTransportemDaneWyszukaneTyp
            Struktura reprezentująca dane zarządzającego transportem możliwe do wyszukania
            • Imiona - optional, nillable; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
            • Nazwisko type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
            • NumerCertyfikatu type NumerCertyfikatuTyp - type undefined with restriction minLength(1) maxLength(100)
            • RodzajCertyfikatu - optional, nillable; type RodzajCertyfikatuTyp - type undefined with restriction - enum { 'krajowy transport drogowy osób', 'krajowy transport drogowy rzeczy', 'międzynarodowy transport drogowy osób', 'międzynarodowy transport drogowy rzeczy', 'certyfikat kompetencji zawodowych w drogowym transporcie osób', 'certyfikat kompetencji zawodowych w drogowym transporcie rzeczy' }
            • DataWydaniaCertyfikatu type date
            • KrajWydajacyCertyfikat type KrajTyp - type undefined with restriction - enum { 'AT', 'BE', 'BG', 'CH', 'CY', 'DK', 'EE', 'FI', 'FR', 'GR', 'ES', 'NL', 'IE', 'LT', 'LU', 'LV', 'MT', 'DE', 'PL', 'PT', 'CZ', 'RO', 'SK', 'SI', 'SE', 'HU', 'UK', 'IT' }
        • ListaZezwolenieNaWykonywanieZawoduPrzewoznikaDrogowegoTyp - optional; type ListaZezwolenieNaWykonywanieZawoduPrzewoznikaDrogowegoTyp
          Lista dla ZezwolenieNaWykonywanieZawoduPrzewoznikaDrogowegoTyp
          • ZezwolenieNaWykonywanieZawoduPrzewoznikaDrogowegoTyp - optional, unbounded; type ZezwolenieNaWykonywanieZawoduPrzewoznikaDrogowegoTyp
            • Zakres type ZakresZezwoleniaTyp - type undefined with restriction - enum { 'Osoby', 'Rzeczy' }
            • Numer type ZezwolenieNumerTyp - type undefined with restriction minLength(1) maxLength(20)
            • StatusZezwolenia type StatusZezwoleniaTyp - type undefined with restriction - enum { 'Ważność wygasła', 'Ważne' }
            • OrganWydajacy type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
            • DataWydania type date
            • DataZmianyStatusu - optional, nillable; type date
            • LiczbaPojazdow - optional; type int
            • DataCofniecia - optional; type date
            • DataWygasniecia - optional; type date
            • DataZawieszenia - optional; type date
            • DataWygasnieciaZawieszenia - optional; type date
            • PowodZawieszeniaLubWycofania - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
        • ListaLicencjaWspolnotowaTyp - optional; type ListaLicencjaWspolnotowaTyp
          Lista dla LicencjaWspolnotowaTyp
          • LicencjaWspolnotowaTyp - optional, unbounded; type LicencjaWspolnotowaTyp
            • Zakres type ZakresLicencjiTyp - type undefined with restriction - enum { 'OsobyPowyzejTrzyIPolTony', 'RzeczyPonizejTrzyIPolTony', 'RzeczyPowyzejTrzyIPolTony' }
            • Numer type LicencjaWspolnotowaNumerTyp - type undefined with restriction minLength(1) maxLength(20)
            • StatusLicencji type StatusLicencjiTyp - type undefined with restriction - enum { 'Zawieszone', 'Wycofane', 'Unieważnione', 'Ważność wygasła', 'Zgubione/ukradzione', 'Odesłane', 'Ważne', 'Anulowane' }
            • PoczatekWaznosci type date
            • KoniecWaznosci - optional, nillable; type date
            • DataCofniecia - optional, nillable; type date
            • DataWygasniecia - optional, nillable; type date
            • DataZawieszenia - optional, nillable; type date
            • DataWygasnieciaZawieszenia - optional, nillable; type date
            • PowodZawieszeniaLubWycofania - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
            • LiczbaPojazdow - optional; type int
        • ListaWypisowZLicencjiTyp - optional; type ListaWypisowZLicencjiTyp
          • Wypis - optional, unbounded; type WypisZLicencjiTyp
            • NumerWypisu type Napis10ZnakowTyp - type undefined with restriction minLength(1) maxLength(10)
            • Rodzaj - optional, nillable; type RodzajWypisuZLicencjiTyp - type undefined with restriction - enum { 'PonizejTrzyIPolTony', 'PowyzejTrzyIPolTony' }
            • Status type StatusWypisuTyp - type undefined with restriction - enum { 'Aktualny', 'Cofniety' }
            • DataCofniecia - optional, nillable; type date
            • DataWygasnieciaCofniecia - optional, nillable; type date
            • ZakresLicencji type ZakresLicencjiTyp - type undefined with restriction - enum { 'OsobyPowyzejTrzyIPolTony', 'RzeczyPonizejTrzyIPolTony', 'RzeczyPowyzejTrzyIPolTony' }
        • ListaWypisowZzezwoleniaTyp - optional; type ListaWypisowZzezwoleniaTyp
          • Wypis - optional, unbounded; type WypisZzezwoleniaTyp
            • ZakresZezwolenia type ZakresZezwoleniaTyp - type undefined with restriction - enum { 'Osoby', 'Rzeczy' }
            • NumerWypisu type Napis10ZnakowTyp - type undefined with restriction minLength(1) maxLength(10)
            • Status type StatusWypisuTyp - type undefined with restriction - enum { 'Aktualny', 'Cofniety' }
        • ListaPrzedstawicieliPrawnychTyp - optional; type ListaPrzedstawicieliPrawnychTyp
          • PrzedstawicielPrawny - optional, unbounded; type PrzedstawicielPrawnyTyp
            • Imiona type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
            • Nazwisko type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
        • Adres - optional; type AdresTyp
          Dane adresowe
          • Kraj type IdentyfikatorWartosciSlownikowejTyp - type undefined with restriction pattern([a-zA-Z0-9]+)
            Wartość pozycji 'Identyfikator' ze słownika 'Kraje'
          • Wojewodztwo - optional; type IdentyfikatorWartosciSlownikowejTyp - type undefined with restriction pattern([a-zA-Z0-9]+)
            Wartość pozycji 'Identyfikator' ze słownika 'Wojewodztwa'
          • Powiat - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • Gmina - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • KodPocztowy type KodPocztowyTyp - type undefined with restriction minLength(1) maxLength(100)
          • Miejscowosc type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • Ulica - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • Budynek - optional, nillable; type Napis10ZnakowTyp - type undefined with restriction minLength(1) maxLength(10)
          • Lokal - optional; type Napis10ZnakowTyp - type undefined with restriction minLength(1) maxLength(10)
      Fault:
      Blad (soap:fault, use = literal)Source code
      error type SzczegolyBledu
      Struktura będąca częścią soap:fault, opisująca szczegółowo błąd
      • KodBledu type KodBledu - type string with restriction - enum { 'NiepoprawnyArgumentOperacji', 'BrakDanych', 'WewnetrznyBladSerwera', 'DuplikacjaDanych', 'StrukturaKomunikatu', 'BrakUprawnien' }
      • KomunikatBledu type string
      • ListaBledowStruktury - optional; type ListaBledowStruktury
        • BladStruktury - optional, unbounded; type BladStruktury
          Informacje o błędzie w strukturze XML komunikatu
          • Sciezka type string
          • Opis type string
    2. WyszukajPrzedsiebiorce
      Description:
      Pobiera szczegółowe dane przedsiębiorcy wskazanego numerem referencyjnym
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      http://api.citizen.kreptd.gitd.gov.pl/v5.0/#WyszukajPrzedsiebiorce
      Input:
      WyszukajPrzedsiebiorce (soap:body, use = literal)Source code
      parameters type WyszukajPrzedsiebiorce
      • parametryWyszukiwaniaPrzedsiebiorcow - nillable; type ParametryWyszukiwaniaPrzedsiebiorcowTyp
        Zestaw parametrów na potrzeby wyszukiwania przedsiębiorców. Wszystkie parametry są opcjonalne. W niektórych parametrach można podać znaki specjalne np. '%'
        • NumerReferencyjny - optional; type NumerReferencyjnyPrzedsiebiorcyTyp - type undefined with restriction pattern(P\/[0-9]{4}\/[0-9]{8,9})
        • FirmaNazwa - optional; type FirmaNazwaTyp - type undefined with restriction maxLength(2000)
        • NIP - optional; type NumerNIPTyp - type undefined with restriction pattern([0-9]{10})
        • ListaZakresowPosiadanychZezwolen - optional; type ListaZakresowPosiadanychZezwolenTyp
          Lista zakresów licencji wspólnotowych lub zezwoleń krajowych wyszukiwanych w ramach ParametryWyszukiwaniaPrzedsiebiorcowTyp
          • ZakresZezwolenia - optional; type ZakresZezwoleniaTyp - type undefined with restriction - enum { 'Osoby', 'Rzeczy' }
        • NumerZezwoleniaRzeczy - optional; type ZezwolenieNumerTyp - type undefined with restriction minLength(1) maxLength(20)
        • NumerZezwoleniaOsoby - optional; type ZezwolenieNumerTyp - type undefined with restriction minLength(1) maxLength(20)
        • ListaZakresowPosiadanychLicencji - optional; type ListaZakresowPosiadanychLicencjiTyp
          Lista zakresów licencji wspólnotowych lub zezwoleń krajowych wyszukiwanych w ramach ParametryWyszukiwaniaPrzedsiebiorcowTyp
          • ZakresLicencji - optional; type ZakresLicencjiTyp - type undefined with restriction - enum { 'OsobyPowyzejTrzyIPolTony', 'RzeczyPonizejTrzyIPolTony', 'RzeczyPowyzejTrzyIPolTony' }
        • NumerLicencjiRzeczy - optional; type LicencjaWspolnotowaNumerTyp - type undefined with restriction minLength(1) maxLength(20)
        • NumerLicencjiOsoby - optional; type LicencjaWspolnotowaNumerTyp - type undefined with restriction minLength(1) maxLength(20)
        • ImieZarzadzajacego - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
        • NazwiskoZarzadzajacego - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
        • NumerCertyfikatuZarzadzajacego - optional; type NumerCertyfikatuTyp - type undefined with restriction minLength(1) maxLength(100)
        • ListaKodowKrajowWydaniaCertyfikatu - optional; type ListaKrajowTyp
          Lista dla KrajTyp
          • Kraj - optional, unbounded; type KrajTyp - type undefined with restriction - enum { 'AT', 'BE', 'BG', 'CH', 'CY', 'DK', 'EE', 'FI', 'FR', 'GR', 'ES', 'NL', 'IE', 'LT', 'LU', 'LV', 'MT', 'DE', 'PL', 'PT', 'CZ', 'RO', 'SK', 'SI', 'SE', 'HU', 'UK', 'IT' }
        • DataWydaniaCertyfikatuOd - optional, nillable; type date
        • DataWydaniaCertyfikatuDo - optional, nillable; type date
        • AdresSiedziby - optional;
          • ListaWojewodztw - optional; type ListaWojewodztwTyp
            Listadla WojewodztwoTyp
            • Wojewodztwo - optional, unbounded; type WojewodztwoTyp - type undefined with restriction - enum { 'dolnośląskie', 'kujawsko-pomorskie', 'lubelskie', 'lubuskie', 'łódzkie', 'małopolskie', 'mazowieckie', 'opolskie', 'podkarpackie', 'podlaskie', 'pomorskie', 'śląskie', 'świętokrzyskie', 'warmińsko-mazurskie', 'wielkopolskie', 'zachodniopomorskie' }
          • Miejscowosc - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • KodPocztowy - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • Ulica - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • Budynek - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
          • Lokal - optional; type Napis100ZnakowTyp - type undefined with restriction minLength(1) maxLength(100)
        • LiczbaWypisowZLicencjiWspolnotowejPowyzejTrzyIPolTonyOd - optional, nillable; type integer
        • LiczbaWypisowZLicencjiWspolnotowejPowyzejTrzyIPolTonyDo - optional, nillable; type integer
        • LiczbaWypisowZLicencjiWspolnotowejPonizejTrzyIPolTonyOd - optional, nillable; type integer
        • LiczbaWypisowZLicencjiWspolnotowejPonizejTrzyIPolTonyDo - optional, nillable; type integer
        • DataOstatniejModyfikacjiRekorduOd - optional, nillable; type date
        • DataOstatniejModyfikacjiRekorduDo - optional, nillable; type date
      Output:
      WyszukajPrzedsiebiorceResponse (soap:body, use = literal)Source code
      parameters type WyszukajPrzedsiebiorceResponse
      • listaPrzedsiebiorcowDaneWyszukane - nillable; type ListaPrzedsiebiorcowDaneWyszukaneTyp
        Lista dla PrzedsiebiorcaDaneWyszukaneTyp
        • PrzedsiebiorcaDaneWyszukane - optional, unbounded; type PrzedsiebiorcaDaneWyszukaneTyp
          Podstawowe dane przedsiębiorcy wyszukanego przez usługę
          • NumerReferencyjny - optional; type NumerReferencyjnyPrzedsiebiorcyTyp - type undefined with restriction pattern(P\/[0-9]{4}\/[0-9]{8,9})
          • FirmaNazwa type FirmaNazwaTyp - type undefined with restriction maxLength(2000)
          • NIP type NumerNIPTyp - type undefined with restriction pattern([0-9]{10})
      Fault:
      Blad (soap:fault, use = literal)Source code
      error type SzczegolyBledu
      Struktura będąca częścią soap:fault, opisująca szczegółowo błąd
      • KodBledu type KodBledu - type string with restriction - enum { 'NiepoprawnyArgumentOperacji', 'BrakDanych', 'WewnetrznyBladSerwera', 'DuplikacjaDanych', 'StrukturaKomunikatu', 'BrakUprawnien' }
      • KomunikatBledu type string
      • ListaBledowStruktury - optional; type ListaBledowStruktury
        • BladStruktury - optional, unbounded; type BladStruktury
          Informacje o błędzie w strukturze XML komunikatu
          • Sciezka type string
          • Opis type string

WSDL source code

<?xml version="1.0"?>
<definitions targetNamespace="http://api.citizen.kreptd.gitd.gov.pl/v5.0" name="KreptdApi"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsa="http://www.w3.org/2006/05/addressing/wsdl"
xmlns:tns="http://api.citizen.kreptd.gitd.gov.pl/v5.0"
xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata"
xmlns:api="http://api.citizen.kreptd.gitd.gov.pl/v5.0/types"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
>
<documentation>Specyfikacja API dla systemów zewnętrznych - klientów systemu KREPTD wersja 1.0</documentation>
<types>
<xsd:schema targetNamespace="http://api.citizen.kreptd.gitd.gov.pl/v5.0" elementFormDefault="qualified">
<!-- Operacje -->
<!-- WyszukajPrzedsiebiorce -->
<!-- PobierzPrzedsiebiorce -->
<!-- Operacje -->
<!-- Obsługa błędów -->
<xsd:complexType name="BladStruktury">
<xsd:annotation>
<xsd:documentation>Informacje o błędzie w strukturze XML komunikatu</xsd:documentation>
</xsd:annotation>
</xsd:complexType>
<!-- Obsługa błędów -->
</xsd:schema>
<schema elementFormDefault="qualified" targetNamespace="http://api.citizen.kreptd.gitd.gov.pl/v5.0/types">
<simpleType name="IdentyfikatorWartosciSlownikowejTyp">
<annotation>
<documentation>Typ reprezentujący unikalny identyfikator wartości słownikowej. Słowniki zdefiniowane w systemie KREPTD można pobrać operacją PobierzListeSlownikow, zaś wartości słownikowe, zawarte w słowniku wraz z opisami, za pomocą operacji PobierzSlownik. Przesłanie wartości słownikowej ze słownika niewłaściwego dla danego elementu obiektu będzie skutkowało błędem. Przykładowo, w kolekcji ListaSrodkowRehabilitacyjnych należy podać identyfikatory ze słownika "Środki rehabilitacji".</documentation>
</annotation>
</simpleType>
<!-- Słowniki -->
<!-- Słowniki -->
<complexType name="ListaZakresowPosiadanychZezwolenTyp">
<annotation>
<documentation>Lista zakresów licencji wspólnotowych lub zezwoleń krajowych wyszukiwanych w ramach ParametryWyszukiwaniaPrzedsiebiorcowTyp</documentation>
</annotation>
</complexType>
<complexType name="ListaZakresowPosiadanychLicencjiTyp">
<annotation>
<documentation>Lista zakresów licencji wspólnotowych lub zezwoleń krajowych wyszukiwanych w ramach ParametryWyszukiwaniaPrzedsiebiorcowTyp</documentation>
</annotation>
</complexType>
<simpleType name="RodzajWypisuZLicencjiTyp">
<annotation>
<documentation>Rodzaj wypisu z licencji</documentation>
</annotation>
<restriction base="string">
<enumeration value="PonizejTrzyIPolTony">
<annotation>
<documentation>"DMC poniżej 3.5 t"</documentation>
</annotation>
</enumeration>
<enumeration value="PowyzejTrzyIPolTony">
<annotation>
<documentation>DMC powyżej 3.5 t</documentation>
</annotation>
</enumeration>
</restriction>
</simpleType>
<simpleType name="NumerReferencyjnyPrzedsiebiorcyTyp">
<annotation>
<documentation>Typ reprezentujący numer referencyjny dla przedsiębiorcy</documentation>
</annotation>
</simpleType>
<!-- Wyszukiwanie przedsiębiorców -->
<complexType name="ParametryWyszukiwaniaPrzedsiebiorcowTyp">
<annotation>
<documentation>Zestaw parametrów na potrzeby wyszukiwania przedsiębiorców. Wszystkie parametry są opcjonalne. W niektórych parametrach można podać znaki specjalne np. '%'</documentation>
</annotation>
<sequence></sequence>
</complexType>
</schema>
</types>
<!-- Message -->
<!-- PobierzPrzedsiebiorce -->
<!-- WyszukajPrzedsiebiorce -->
<!-- Message -->
<portType name="CitizenApi">
<!-- WyszukajPrzedsiebiorce -->
<!-- PobierzPrzedsiebiorce -->
</portType>
<!-- Usługa -->
</definitions>

About wsdl-viewer.xsl

This document was generated by SAXON 9.1.0.8 from Saxonica XSLT engine. The engine processed the WSDL in XSLT 2.0 compliant mode.
This page has been generated bywsdl-viewer.xsl, version 3.1.02
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.

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