Tax Filing Service

<back to all web services

HolePortalZertifikatEigenschaften

SyncHoleZertifikat

A synchronous service to get the properties of a specified portal certificate.

Requires Authentication
The following routes are available for this service:
POST/HolePortalZertifikatEigenschaftenA synchronous service to get the properties of a specified portal certificate.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* A synchronous service to get the properties of a specified portal certificate.
*/
@Api(Description="A synchronous service to get the properties of a specified portal certificate.")
open class HolePortalZertifikatEigenschaften : HolePortalZertifikatEigenschaftenBase()
{
}

/**
* A base service to get the properties of a specified portal certificate.
*/
@Api(Description="A base service to get the properties of a specified portal certificate.")
open class HolePortalZertifikatEigenschaftenBase : IPost
{
    /**
    * The portal certificate.
    */
    @ApiMember(Description="The portal certificate.", Name="Zertifikat")
    open var zertifikat:PortalCertificate? = null
}

/**
* Represents a portal certificate that is protected by a password.
*/
@Api(Description="Represents a portal certificate that is protected by a password.")
open class PortalCertificate : FileBase(), ISecuredCertificate
{
    /**
    * The file name of the certificate.
    */
    @ApiMember(Description="The file name of the certificate.")
    @StringLength(MaximumLength=128)
    open var name:String? = null

    /**
    * The password to protect the certificate from unauthorized access.
    */
    @StringLength(MaximumLength=255)
    @ApiMember(Description="The password to protect the certificate from unauthorized access.")
    override var pin:String? = null

    /**
    * The description of the certificate.
    */
    @StringLength(MaximumLength=2147483647)
    @ApiMember(Description="The description of the certificate.")
    open var description:String? = null

    /**
    * Tags that can be used to label or identify the certificate.
    */
    @ApiMember(Description="Tags that can be used to label or identify the certificate.")
    open var tags:ArrayList<String> = ArrayList<String>()
}

/**
* Represents a base class for a file with raw data.
*/
@Api(Description="Represents a base class for a file with raw data.")
open class FileBase
{
    /**
    * The raw data content of the file in bytes.
    */
    @ApiMember(Description="The raw data content of the file in bytes.", Name="Content")
    open var content:ByteArray? = null
}

/**
* Represents a type that encapsulates the return values of the ERiC API function, which retrieves the details of a certificate.
*/
@Api(Description="Represents a type that encapsulates the return values of the ERiC API function, which retrieves the details of a certificate.")
open class HoleZertifikatEigenschaftenResponse : EricFehlerCodeResponse()
{
    /**
    * The list of test fiscal authoririties.
    */
    @ApiMember(Description="The list of test fiscal authoririties.")
    open var rueckgabe:EricHoleZertifikatEigenschaften? = 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.")
    open var statusCode:EricFehlerCode? = null

    /**
    * The status message that the ERiC API function returns.
    */
    @ApiMember(Description="The status message that the ERiC API function returns.")
    open var statusText:String? = 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.")
    open 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.")
    override 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.")
    open 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),
    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),
    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),
    EricCryptEEsignerNichtGeladen(610201140),
    EricCryptEInkompatibleEsignerVersion(610201141),
    EricCryptEVeralteteEsignerVersion(610201142),
    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),
    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),
    EricCryptEDataNotInitialized(610201228),
    EricCryptEAsN1ReadBufferTooSmall(610201229),
    EricCryptEAsN1ReadDataIncomplete(610201230),
    EricCryptEAsN1NoEnvelopedData(610201231),
    EricCryptEAsN1NoContentData(610201232),
    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),
    EricIoReaderRabeFehler(610301170),
    EricIoReaderKeineRabeid(610301171),
    EricIoReaderRabeidUngueltig(610301172),
    EricIoReaderRabeVerifikationsidUngueltig(610301173),
    EricIoReaderRabeReferenzidUngueltig(610301174),
    EricIoReaderRabeReferenzidNichtErlaubt(610301175),
    EricIoReaderRabeReferenzidsNichtEindeutig(610301176),
    EricIoReaderZuVieleAnhaenge(610301190),
    EricIoReaderAnhangZuGross(610301191),
    EricIoReaderAnhaengeZuGross(610301192),
    EricIoReaderAnhangZuKlein(610301193),
    EricIoReaderSchemaValidierungsfehler(610301200),
    EricIoReaderUnbekannteXmlEntity(610301201),
    EricIoTestherstelleridGesperrt(610301202),
    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),
    EricPrintPdfcallback(610501015),
}

/**
* Represents a list of properties for a specified certificate.
*/
@Api(Description="Represents a list of properties for a specified certificate.")
open class EricHoleZertifikatEigenschaften
{
    /**
    * The properties of the certificate used for signing. These are not available for client-side certificates.
    */
    @ApiMember(Description="The properties of the certificate used for signing. These are not available for client-side certificates.")
    open var signaturzertifikateigenschaften:Zertifikateigenschaften? = null

    /**
    * The properties of certificates used for encryption.
    */
    @ApiMember(Description="The properties of certificates used for encryption.")
    open var verschluesselungszertifikateigenschaften:Zertifikateigenschaften? = null
}

/**
* Represents the characteristics of a certificate.
*/
@Api(Description="Represents the characteristics of a certificate.")
open class Zertifikateigenschaften
{
    /**
    * The start validity date of the certificate.
    */
    @ApiMember(Description="The start validity date of the certificate.")
    open var ausgestelltAm:Date? = null

    /**
    * The expiry date of the certificate.
    */
    @ApiMember(Description="The expiry date of the certificate.")
    open var gueltigBis:Date? = null

    /**
    * The signing algorithm and Object Identifier (for more information on OIDs, please see 'http://www.oid-info.com/')
    */
    @ApiMember(Description="The signing algorithm and Object Identifier (for more information on OIDs, please see 'http://www.oid-info.com/')")
    open var signaturalgorithmus:String? = null

    /**
    * The MD5-hash of the public key.
    */
    @ApiMember(Description="The MD5-hash of the public key.")
    open var publicKeyMD5:String? = null

    /**
    * The SHA1-hash of the public key.
    */
    @ApiMember(Description="The SHA1-hash of the public key.")
    open var publicKeySHA1:String? = null

    /**
    * The key length of the public key in units of bits. For example '2048 bits'
    */
    @ApiMember(Description="The key length of the public key in units of bits. For example '2048 bits'")
    open var publicKeyBitLength:Int? = null

    /**
    * The issuer of the certificate.
    */
    @ApiMember(Description="The issuer of the certificate.")
    open var issuer:Issuer? = null

    /**
    * The subject of the certificate.
    */
    @ApiMember(Description="The subject of the certificate.")
    open var subjekt:Subjekt? = null

    /**
    * The identification characteristics of the certificate.
    */
    @ApiMember(Description="The identification characteristics of the certificate.")
    open var identifikationsmerkmaltyp:Identifikationsmerkmaltyp? = null

    /**
    * The type of registrar, to which the key is issued.
    */
    @ApiMember(Description="The type of registrar, to which the key is issued.")
    open var registrierertyp:Registrierertyp? = null

    /**
    * The type of verification conducted for the person or organisation, to which the certificate is issued.
    */
    @ApiMember(Description="The type of verification conducted for the person or organisation, to which the certificate is issued.")
    open var verifikationsart:VerifikationsartTyp? = null

    /**
    * The type of token used to create the certificate.
    */
    @ApiMember(Description="The type of token used to create the certificate.")
    open var tokenTyp:TokenTyp? = null

    /**
    * Is the certificate is a test certificate? True if it is a test certificate; otherwise false.
    */
    @ApiMember(Description="Is the certificate is a test certificate? True if it is a test certificate; otherwise false.")
    open var testzertifikat:Boolean? = null
}

/**
* Represents an issuer of certificates.
*/
@Api(Description="Represents an issuer of certificates.")
open class Issuer
{
    /**
    * Details about the issuer of certificates.
    */
    @ApiMember(Description="Details about the issuer of certificates.")
    open var infos:ArrayList<Info> = ArrayList<Info>()
}

/**
* Represent issuer details of a certificate.
*/
@Api(Description="Represent issuer details of a certificate.")
open class Info
{
    /**
    * The name of the issuer detail.
    */
    @ApiMember(Description="The name of the issuer detail.")
    open var name:String? = null

    /**
    * The value of the issuer detail.
    */
    @ApiMember(Description="The value of the issuer detail.")
    open var wert:String? = null
}

/**
* Represents the subject of the certificate.
*/
@Api(Description="Represents the subject of the certificate.")
open class Subjekt
{
    /**
    * Details about the subject of the certificate.
    */
    @ApiMember(Description="Details about the subject of the certificate.")
    open var infos:ArrayList<Info> = ArrayList<Info>()
}

/**
* Represents a type of Identification characteristic. Identification marker that was specified when the certificate was generated. For portal certificates usually tax number or identification number.
*/
enum class Identifikationsmerkmaltyp
{
    Unbekannt,
    Steuernummer,
    Identifikationsnummer,
    BzStNummer,
    Bearbeiternummer,
    Clienterzeugt,
}

/**
* Represents a type of registrar. Contains informatiom on the type of person or organization, for which a certificate is issued. Often 'Person' or 'Organisation'.
*/
enum class Registrierertyp
{
    Unbekannt,
    Person,
    Organisation,
    Rechteverwalter,
    BzStInland,
    BzStAusland,
    BzStKevizz,
}

/**
* Represents a type of verification. Contains information on the verification of a person or organisation by an issuer of certificates.
*/
enum class VerifikationsartTyp
{
    Unbekannt,
    Postweg,
    Neuerpersonalausweis,
}

/**
* Represents a type of token.Contains information about the type of token used to create a certificate.
*/
enum class TokenTyp
{
    Unbekannt,
    Software,
    Stick,
    Karte,
    Ausweis,
}

Kotlin HolePortalZertifikatEigenschaften DTOs

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

HTTP + JSV

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

POST /HolePortalZertifikatEigenschaften HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	zertifikat: 
	{
		name: String,
		pin: String,
		description: String,
		tags: 
		[
			String
		],
		content: AA==
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	rueckgabe: 
	{
		signaturzertifikateigenschaften: 
		{
			ausgestelltAm: 0001-01-01,
			gueltigBis: 0001-01-01,
			signaturalgorithmus: String,
			publicKeyMD5: String,
			publicKeySHA1: String,
			publicKeyBitLength: 0,
			issuer: 
			{
				infos: 
				[
					{
						name: String,
						wert: String
					}
				]
			},
			subjekt: 
			{
				infos: 
				[
					{
						name: String,
						wert: String
					}
				]
			},
			identifikationsmerkmaltyp: Unbekannt,
			registrierertyp: Unbekannt,
			verifikationsart: Unbekannt,
			tokenTyp: Unbekannt,
			testzertifikat: False
		},
		verschluesselungszertifikateigenschaften: 
		{
			ausgestelltAm: 0001-01-01,
			gueltigBis: 0001-01-01,
			signaturalgorithmus: String,
			publicKeyMD5: String,
			publicKeySHA1: String,
			publicKeyBitLength: 0,
			issuer: 
			{
				infos: 
				[
					{
						name: String,
						wert: String
					}
				]
			},
			subjekt: 
			{
				infos: 
				[
					{
						name: String,
						wert: String
					}
				]
			},
			identifikationsmerkmaltyp: Unbekannt,
			registrierertyp: Unbekannt,
			verifikationsart: Unbekannt,
			tokenTyp: Unbekannt,
			testzertifikat: False
		}
	},
	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
		}
	}
}
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.