Tax Filing Service
| GET | /VersionCheckAsync | An 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.*;
public class dtos
{
/**
* 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.")
public static class VersionCheckAsync extends 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.")
public static class VersionCheckBase implements 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.")
public static class EricVersionResponse extends EricFehlerCodeResponse
{
/**
* The version of an ERiC library component.
*/
@ApiMember(Description="The version of an ERiC library component.")
public EricVersion rueckgabe = null;
/**
* The status code that the ERiC API function returns.
*/
@ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public EricFehlerCode statusCode = null;
/**
* The status message that the ERiC API function returns.
*/
@ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public String statusText = null;
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
public String id = 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")
public Integer index = 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")
public ResponseStatus responseStatus = null;
public EricVersion getRueckgabe() { return rueckgabe; }
public EricVersionResponse setRueckgabe(EricVersion value) { this.rueckgabe = value; return this; }
public EricFehlerCode getStatusCode() { return statusCode; }
public EricVersionResponse setStatusCode(EricFehlerCode value) { this.statusCode = value; return this; }
public String getStatusText() { return statusText; }
public EricVersionResponse setStatusText(String value) { this.statusText = value; return this; }
public String getId() { return id; }
public EricVersionResponse setId(String value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public EricVersionResponse setIndex(Integer value) { this.index = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public EricVersionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* 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.")
public static class EricFehlerCodeResponse extends ServiceReponseBase
{
/**
* The status code that the ERiC API function returns.
*/
@ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public EricFehlerCode statusCode = null;
/**
* The status message that the ERiC API function returns.
*/
@ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public String statusText = null;
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
public String id = 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")
public Integer index = 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")
public ResponseStatus responseStatus = null;
public EricFehlerCode getStatusCode() { return statusCode; }
public EricFehlerCodeResponse setStatusCode(EricFehlerCode value) { this.statusCode = value; return this; }
public String getStatusText() { return statusText; }
public EricFehlerCodeResponse setStatusText(String value) { this.statusText = value; return this; }
public String getId() { return id; }
public EricFehlerCodeResponse setId(String value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public EricFehlerCodeResponse setIndex(Integer value) { this.index = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public EricFehlerCodeResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Specifies a service response from an ERiC service operation.
*/
@Api(Description="Specifies a service response from an ERiC service operation.")
public static class ServiceReponseBase implements IHasIndex
{
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
public String id = 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")
public Integer index = 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")
public ResponseStatus responseStatus = null;
public String getId() { return id; }
public ServiceReponseBase setId(String value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public ServiceReponseBase setIndex(Integer value) { this.index = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public ServiceReponseBase setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Enumeration of ERiC API error codes.
*/
public static enum EricFehlerCode
{
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);
private final int value;
EricFehlerCode(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
/**
* Represents a structure that encapsulates a list of ERiC dynamic libraries.
*/
@Api(Description="Represents a structure that encapsulates a list of ERiC dynamic libraries.")
public static class EricVersion
{
/**
* The list of available ERiC dynamic libraries.
*/
@ApiMember(Description="The list of available ERiC dynamic libraries.")
public ArrayList<Bibliothek> bibliotheken = null;
public ArrayList<Bibliothek> getBibliotheken() { return bibliotheken; }
public EricVersion setBibliotheken(ArrayList<Bibliothek> value) { this.bibliotheken = value; return this; }
}
/**
* Represents Represents an ERiC dynamic library.
*/
@Api(Description="Represents Represents an ERiC dynamic library.")
public static class Bibliothek
{
/**
* The name of the library.
*/
@ApiMember(Description="The name of the library.")
public String name = null;
/**
* The product version of the library.
*/
@ApiMember(Description="The product version of the library.")
public String produktversion = null;
/**
* The file version of the library.
*/
@ApiMember(Description="The file version of the library.")
public String dateiversion = null;
/**
* The list of test modules of the library.
*/
@ApiMember(Description="The list of test modules of the library.")
public ArrayList<PruefModul> pruefModulen = null;
public String getName() { return name; }
public Bibliothek setName(String value) { this.name = value; return this; }
public String getProduktversion() { return produktversion; }
public Bibliothek setProduktversion(String value) { this.produktversion = value; return this; }
public String getDateiversion() { return dateiversion; }
public Bibliothek setDateiversion(String value) { this.dateiversion = value; return this; }
public ArrayList<PruefModul> getPruefModulen() { return pruefModulen; }
public Bibliothek setPruefModulen(ArrayList<PruefModul> value) { this.pruefModulen = value; return this; }
}
/**
* Represent a version of the internally used test module.
*/
@Api(Description="Represent a version of the internally used test module.")
public static class PruefModul
{
/**
* The tax data type version of the test module.
*/
@ApiMember(Description="The tax data type version of the test module.")
public String datenartVersion = null;
/**
* The label of the test module.
*/
@ApiMember(Description="The label of the test module.")
public String label = null;
/**
* The runtime of the test module.
*/
@ApiMember(Description="The runtime of the test module.")
public String runtime = null;
public String getDatenartVersion() { return datenartVersion; }
public PruefModul setDatenartVersion(String value) { this.datenartVersion = value; return this; }
public String getLabel() { return label; }
public PruefModul setLabel(String value) { this.label = value; return this; }
public String getRuntime() { return runtime; }
public PruefModul setRuntime(String value) { this.runtime = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
rueckgabe:
{
bibliotheken:
[
{
name: String,
produktversion: String,
dateiversion: String,
pruefModulen:
[
{
datenartVersion: String,
label: String,
runtime: String
}
]
}
]
},
statusCode: ERIC_OK,
statusText: String,
id: String,
index: 0,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}