Tax Filing Service

<back to all web services

VersionCheckAsync

AsyncÜberprüfung

An asynchronous service to retrieve the list of all product and file versions of used ERiC-libraries.

Requires Authentication
The following routes are available for this service:
GET/VersionCheckAsyncAn asynchronous service to retrieve the list of all product and file versions of used ERiC-libraries.
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* An asynchronous service to retrieve the list of all product and file versions of used ERiC-libraries.
*/
@Api(Description="An asynchronous service to retrieve the list of all product and file versions of used ERiC-libraries.")
open class VersionCheckAsync : VersionCheckBase()
{
}

/**
* A base service to retrieve the list of all product and file versions of used ERiC-libraries.
*/
@Api(Description="A base service to retrieve the list of all product and file versions of used ERiC-libraries.")
open class VersionCheckBase : IGet
{
}

/**
* Represents a type that encapsulates the versions of ERiC library components.
*/
@Api(Description="Represents a type that encapsulates the versions of ERiC library components.")
open class EricVersionResponse : EricFehlerCodeResponse()
{
    /**
    * The version of an ERiC library component.
    */
    @ApiMember(Description="The version of an ERiC library component.")
    var rueckgabe:EricVersion? = null

    /**
    * The status code that the ERiC API function returns.
    */
    @ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
    var statusCode:EricFehlerCode? = null

    /**
    * The status message that the ERiC API function returns.
    */
    @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
    var statusText:String? = null

    /**
    * The unique identifier of the response.
    */
    @ApiMember(Description="The unique identifier of the response.", Name="Id")
    var id:String? = null

    /**
    * The position of the response element in an indexed collection.
    */
    @ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
    var index:Int? = null

    /**
    * Metadata that contains structured error information on the service response.
    */
    @ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
    var responseStatus:ResponseStatus? = null
}

/**
* Represent a base response that encapsulate any ERiC API function return value.
*/
@Api(Description="Represent a base response that encapsulate any ERiC API function return value.")
open class EricFehlerCodeResponse : ServiceReponseBase()
{
    /**
    * The status code that the ERiC API function returns.
    */
    @ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
    var statusCode:EricFehlerCode? = null

    /**
    * The status message that the ERiC API function returns.
    */
    @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
    var statusText:String? = null

    /**
    * The unique identifier of the response.
    */
    @ApiMember(Description="The unique identifier of the response.", Name="Id")
    var id:String? = null

    /**
    * The position of the response element in an indexed collection.
    */
    @ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
    var index:Int? = null

    /**
    * Metadata that contains structured error information on the service response.
    */
    @ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
    var responseStatus:ResponseStatus? = null
}

/**
* Specifies a service response from an ERiC service operation.
*/
@Api(Description="Specifies a service response from an ERiC service operation.")
open class ServiceReponseBase : IHasIndex
{
    /**
    * The unique identifier of the response.
    */
    @ApiMember(Description="The unique identifier of the response.", Name="Id")
    var id:String? = null

    /**
    * The position of the response element in an indexed collection.
    */
    @ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
    var index:Int? = null

    /**
    * Metadata that contains structured error information on the service response.
    */
    @ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
    var responseStatus:ResponseStatus? = null
}

/**
* Enumeration of ERiC API error codes.
*/
enum class EricFehlerCode(val value:Int)
{
    EricOk(0),
    EricGlobalUnknown(610001001),
    EricGlobalPruefFehler(610001002),
    EricGlobalHinweise(610001003),
    EricGlobalFehlermeldungNichtVorhanden(610001007),
    EricGlobalKeineDatenVorhanden(610001008),
    EricGlobalNichtGenuegendArbeitsspeicher(610001013),
    EricGlobalDateiNichtGefunden(610001014),
    EricGlobalHerstellerIdNichtErlaubt(610001016),
    EricGlobalIllegalState(610001017),
    EricGlobalFunktionNichtErlaubt(610001018),
    EricGlobalEchtfallNichtErlaubt(610001019),
    EricGlobalNoVersandInBetaVersion(610001020),
    EricGlobalTestmerkerUngueltig(610001025),
    EricGlobalDatensatzZuGross(610001026),
    EricGlobalVerschluesselungsParameterNichtErlaubt(610001027),
    EricGlobalNurPortalzertifikatErlaubt(610001028),
    EricGlobalAbrufcodeNichtErlaubt(610001029),
    EricGlobalErrorXmlCreate(610001030),
    EricGlobalTextpuffergroesseFix(610001031),
    EricGlobalInternerFehler(610001032),
    EricGlobalArithmetikfehler(610001033),
    EricGlobalSteuernummerUngueltig(610001034),
    EricGlobalSteuernummerFalscheLaenge(610001035),
    EricGlobalSteuernummerNichtNumerisch(610001036),
    EricGlobalLandesnummerUnbekannt(610001037),
    EricGlobalBufanrUnbekannt(610001038),
    EricGlobalLandesnummerBufanr(610001039),
    EricGlobalPufferZugriffskonflikt(610001040),
    EricGlobalPufferUeberlauf(610001041),
    EricGlobalDatenartversionUnbekannt(610001042),
    EricGlobalDatenartversionXmlInkonsistent(610001044),
    EricGlobalCommondataNichtVerfuegbar(610001045),
    EricGlobalLogException(610001046),
    EricGlobalTransportschluesselNichtErlaubt(610001047),
    EricGlobalOeffentlicherSchluesselUngueltig(610001048),
    EricGlobalTransportschluesselTypFalsch(610001049),
    EricGlobalPufferUngleicherInstanz(610001050),
    EricGlobalVorsatzUngueltig(610001051),
    EricGlobalDateizugriffVerweigert(610001053),
    EricGlobalUngueltigeInstanz(610001080),
    EricGlobalNichtInitialisiert(610001081),
    EricGlobalMehrfacheInitialisierung(610001082),
    EricGlobalFehlerInitialisierung(610001083),
    EricGlobalUnknownParameterError(610001102),
    EricGlobalCheckCorruptedNds(610001108),
    EricGlobalVerschluesselungsParameterNichtAngegeben(610001206),
    EricGlobalSendFlagMehrAlsEines(610001209),
    EricGlobalUngueltigeFlagKombination(610001218),
    EricGlobalErsteSeiteDruckNichtUnterstuetzt(610001220),
    EricGlobalUngueltigerParameter(610001222),
    EricGlobalDruckFuerVerfahrenNichtErlaubt(610001224),
    EricGlobalVersandArtNichtUnterstuetzt(610001225),
    EricGlobalUngueltigeParameterVersion(610001226),
    EricGlobalTransferhandle(610001227),
    EricGlobalPlugininitialisierung(610001228),
    EricGlobalInkompatibleVersionen(610001229),
    EricGlobalVerschluesselungsverfahrenNichtUnterstuetzt(610001230),
    EricGlobalMehrfachaufrufeNichtUnterstuetzt(610001231),
    EricGlobalUtiCountryNotSupported(610001404),
    EricGlobalIbanFormalerFehler(610001501),
    EricGlobalIbanLaendercodeFehler(610001502),
    EricGlobalIbanLandesformatFehler(610001503),
    EricGlobalIbanPruefzifferFehler(610001504),
    EricGlobalBicFormalerFehler(610001510),
    EricGlobalBicLaendercodeFehler(610001511),
    EricGlobalZulassungsnummerZuLang(610001519),
    EricGlobalIdnummerUngueltig(610001525),
    EricGlobalNullParameter(610001526),
    EricGlobalEwazUngueltig(610001527),
    EricGlobalEwazLandeskuerzelUnbekannt(610001528),
    EricGlobalUpdateNecessary(610001851),
    EricGlobalEinstellungNameUngueltig(610001860),
    EricGlobalEinstellungWertUngueltig(610001861),
    EricGlobalErrDekodieren(610001862),
    EricGlobalFunktionNichtUnterstuetzt(610001863),
    EricGlobalNutzdatenticketsNichtEindeutig(610001865),
    EricGlobalNutzdatenheaderversionenUneinheitlich(610001866),
    EricGlobalBundeslaenderUneinheitlich(610001867),
    EricGlobalZeitraeumeUneinheitlich(610001868),
    EricGlobalNutzdatenheaderEmpfaengerNichtKorrekt(610001869),
    EricTransferComError(610101200),
    EricTransferVorgangNichtUnterstuetzt(610101201),
    EricTransferErrXmlTheader(610101210),
    EricTransferErrParam(610101251),
    EricTransferErrDatenteilendnotfound(610101253),
    EricTransferErrBegindatenlieferant(610101255),
    EricTransferErrEnddatenlieferant(610101256),
    EricTransferErrBegintransportschluessel(610101257),
    EricTransferErrEndtransportschluessel(610101258),
    EricTransferErrBegindatengroesse(610101259),
    EricTransferErrEnddatengroesse(610101260),
    EricTransferErrSend(610101271),
    EricTransferErrNotencrypted(610101274),
    EricTransferErrProxyconnect(610101276),
    EricTransferErrConnectserver(610101278),
    EricTransferErrNoresponse(610101279),
    EricTransferErrProxyauth(610101280),
    EricTransferErrSendInit(610101282),
    EricTransferErrTimeout(610101283),
    EricTransferErrProxyportInvalid(610101284),
    EricTransferErrOther(610101291),
    EricTransferErrXmlNheader(610101292),
    EricTransferErrXmlEncoding(610101293),
    EricTransferErrEndsiguser(610101294),
    EricTransferErrXmltagNichtGefunden(610101295),
    EricTransferErrDatenteilfehler(610101297),
    EricTransferEidZertifikatfehler(610101500),
    EricTransferEidKeinkonto(610101510),
    EricTransferEidIdnrnichteindeutig(610101511),
    EricTransferEidServerfehler(610101512),
    EricTransferEidKeinclient(610101520),
    EricTransferEidClientfehler(610101521),
    EricTransferEidFehlendefelder(610101522),
    EricTransferEidIdentifikationabgebrochen(610101523),
    EricTransferEidNpablockiert(610101524),
    EricCryptErrorCreateKey(610201016),
    EricCryptEInvalidHandle(610201101),
    EricCryptEMaxSession(610201102),
    EricCryptEBusy(610201103),
    EricCryptEOutOfMem(610201104),
    EricCryptEPsePath(610201105),
    EricCryptEPinWrong(610201106),
    EricCryptEPinLocked(610201107),
    EricCryptEP7Read(610201108),
    EricCryptEP7Decode(610201109),
    EricCryptEP7Recipient(610201110),
    EricCryptEP12Read(610201111),
    EricCryptEP12Decode(610201112),
    EricCryptEP12SigKey(610201113),
    EricCryptEP12EncKey(610201114),
    EricCryptEP11SigKey(610201115),
    EricCryptEP11EncKey(610201116),
    EricCryptEXmlParse(610201117),
    EricCryptEXmlSigAdd(610201118),
    EricCryptEXmlSigTag(610201119),
    EricCryptEXmlSigSign(610201120),
    EricCryptEEncodeUnknown(610201121),
    EricCryptEEncodeError(610201122),
    EricCryptEXmlInit(610201123),
    EricCryptEEncrypt(610201124),
    EricCryptEDecrypt(610201125),
    EricCryptEP11SlotEmpty(610201126),
    EricCryptENoSigEncKey(610201127),
    EricCryptELoadDll(610201128),
    EricCryptENoService(610201129),
    EricCryptEEsiclException(610201130),
    EricCryptETokenTypeMismatch(610201144),
    EricCryptEP12Create(610201146),
    EricCryptEVerifyCertChain(610201147),
    EricCryptEP11EngineLoaded(610201148),
    EricCryptEUserCancel(610201149),
    EricCryptZertifikat(610201200),
    EricCryptSignatur(610201201),
    EricCryptNichtUnterstuetztesPseFormat(610201203),
    EricCryptPinBenoetigt(610201205),
    EricCryptPinStaerkeNichtAusreichend(610201206),
    EricCryptEIntern(610201208),
    EricCryptZertifikatspfadKeinVerzeichnis(610201209),
    EricCryptZertifikatsdateiExistiertBereits(610201210),
    EricCryptPinEnthaeltUngueltigeZeichen(610201211),
    EricCryptEInvalidParamAbc(610201212),
    EricCryptCorrupted(610201213),
    EricCryptEidkarteNichtUnterstuetzt(610201214),
    EricCryptEScSlotEmpty(610201215),
    EricCryptEScNoApplet(610201216),
    EricCryptEScSession(610201217),
    EricCryptEP11NoSigCert(610201218),
    EricCryptEP11InitFailed(610201219),
    EricCryptEP11NoEncCert(610201220),
    EricCryptEP12NoSigCert(610201221),
    EricCryptEP12NoEncCert(610201222),
    EricCryptEScEncKey(610201223),
    EricCryptEScNoSigCert(610201224),
    EricCryptEScNoEncCert(610201225),
    EricCryptEScInitFailed(610201226),
    EricCryptEScSigKey(610201227),
    EricIoFehler(610301001),
    EricIoDateiInkorrekt(610301005),
    EricIoParseFehler(610301006),
    EricIoNdsGenerierungFehlgeschlagen(610301007),
    EricIoMasterdatenserviceNichtVerfuegbar(610301010),
    EricIoSteuerzeichenImNds(610301014),
    EricIoVersionsinformationenNichtGefunden(610301031),
    EricIoFalschesVerfahren(610301104),
    EricIoReaderMehrfacheSteuerfaelle(610301105),
    EricIoReaderUnerwarteteElemente(610301106),
    EricIoReaderFormaleFehler(610301107),
    EricIoReaderFalschesEncoding(610301108),
    EricIoReaderMehrfacheNutzdatenElemente(610301109),
    EricIoReaderMehrfacheNutzdatenblockElemente(610301110),
    EricIoUnbekannteDatenart(610301111),
    EricIoReaderUntersachbereichUngueltig(610301114),
    EricIoReaderZuVieleNutzdatenblockElemente(610301115),
    EricIoReaderSteuerzeichenImTransferheader(610301150),
    EricIoReaderSteuerzeichenImNutzdatenheader(610301151),
    EricIoReaderSteuerzeichenInDenNutzdaten(610301152),
    EricIoReaderZuVieleAnhaenge(610301190),
    EricIoReaderAnhangZuGross(610301191),
    EricIoReaderAnhaengeZuGross(610301192),
    EricIoReaderSchemaValidierungsfehler(610301200),
    EricIoReaderUnbekannteXmlEntity(610301201),
    EricIoDatenteilnotfound(610301252),
    EricIoDatenteilendnotfound(610301253),
    EricIoUebergabeparameterFehlerhaft(610301300),
    EricIoUngueltigeUtF8Sequenz(610301400),
    EricIoUngueltigeZeichenInParameter(610301401),
    EricPrintInternerFehler(610501001),
    EricPrintDruckvorlageNichtGefunden(610501002),
    EricPrintUngueltigerDateiPfad(610501004),
    EricPrintInitialisierungFehlerhaft(610501007),
    EricPrintAusgabezielUnbekannt(610501008),
    EricPrintAbbruchDruckvorbereitung(610501009),
    EricPrintAbbruchGenerierung(610501010),
    EricPrintSteuerfallNichtUnterstuetzt(610501011),
    EricPrintFusstextZuLang(610501012),
}

/**
* Represents a structure that encapsulates a list of ERiC dynamic libraries.
*/
@Api(Description="Represents a structure that encapsulates a list of ERiC dynamic libraries.")
open class EricVersion
{
    /**
    * The list of available ERiC dynamic libraries.
    */
    @ApiMember(Description="The list of available ERiC dynamic libraries.")
    var bibliotheken:ArrayList<Bibliothek> = ArrayList<Bibliothek>()
}

/**
* Represents Represents an ERiC dynamic library.
*/
@Api(Description="Represents Represents an ERiC dynamic library.")
open class Bibliothek
{
    /**
    * The name of the library.
    */
    @ApiMember(Description="The name of the library.")
    var name:String? = null

    /**
    * The product version of the library.
    */
    @ApiMember(Description="The product version of the library.")
    var produktversion:String? = null

    /**
    * The file version of the library.
    */
    @ApiMember(Description="The file version of the library.")
    var dateiversion:String? = null

    /**
    * The list of test modules of the library.
    */
    @ApiMember(Description="The list of test modules of the library.")
    var pruefModulen:ArrayList<PruefModul> = ArrayList<PruefModul>()
}

/**
* Represent a version of the internally used test module.
*/
@Api(Description="Represent a version of the internally used test module.")
open class PruefModul
{
    /**
    * The tax data type version of the test module.
    */
    @ApiMember(Description="The tax data type version of the test module.")
    var datenartVersion:String? = null

    /**
    * The label of the test module.
    */
    @ApiMember(Description="The label of the test module.")
    var label:String? = null

    /**
    * The runtime of the test module.
    */
    @ApiMember(Description="The runtime of the test module.")
    var runtime:String? = null
}

Kotlin VersionCheckAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /VersionCheckAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EricVersionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <Id>String</Id>
  <Index>0</Index>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StatusCode>ERIC_OK</StatusCode>
  <StatusText>String</StatusText>
  <Rueckgabe>
    <Bibliothek>
      <Name>String</Name>
      <Produktversion>String</Produktversion>
      <Dateiversion>String</Dateiversion>
      <PruefModul>
        <DatenartVersion>String</DatenartVersion>
        <Label>String</Label>
        <Runtime>String</Runtime>
      </PruefModul>
    </Bibliothek>
  </Rueckgabe>
</EricVersionResponse>