Tax Filing Service

<back to all web services

HoleZertifikatFingerabdruckAsync

AsyncHoleZertifikat

An asynchronous service to get the fingerprint of a specified client-side certificate

Requires Authentication
The following routes are available for this service:
POST/HoleZertifikatFingerabdruck
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* An asynchronous service to get the fingerprint of a specified client-side certificate
*/
@Api(Description="An asynchronous service to get the fingerprint of a specified client-side certificate")
open class HoleZertifikatFingerabdruckAsync : HoleZertifikatFingerabdruckBase()
{
}

open class HoleZertifikatFingerabdruckBase : IPost
{
    /**
    * The client-side certificate. Access is protected by a PIN.
    */
    @ApiMember(Description="The client-side certificate. Access is protected by a PIN.")
    open var zertifikat:ClientSideCertificate? = null
}

/**
* Represents a client-side generated certificate that is protected by a password.
*/
@Api(Description="Represents a client-side generated certificate that is protected by a password.")
open class ClientSideCertificate : ISecuredCertificate
{
    /**
    * The friendly name of the certificate.
    */
    @ApiMember(Description="The friendly name of the certificate.", IsRequired=true)
    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.", IsRequired=true)
    override var pin:String? = null

    /**
    * The file that contains the private key. Access is protected by the PIN.
    */
    @ApiMember(Description="The file that contains the private key. Access is protected by the PIN.", IsRequired=true)
    open var privateKeyFile:BinaryFile? = null

    /**
    * The file that contains the certificate data and public key.
    */
    @ApiMember(Description="The file that contains the certificate data and public key.", IsRequired=true)
    open var publicKeyFile:BinaryFile? = null

    /**
    * Contains the checksum of the files PublicKeyFile and PrivateKeyFile.
    */
    @ApiMember(Description="Contains the checksum of the files PublicKeyFile and PrivateKeyFile.", IsRequired=true)
    open var checksumFile:BinaryFile? = null

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

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

/**
* Represents a generic file that contains raw data content in bytes
*/
@Api(Description="Represents a generic file that contains raw data content in bytes")
open class BinaryFile : FileBase()
{
    /**
    * The attributes of the file.
    */
    @ApiMember(Description="The attributes of the file.")
    open var metadata:FileMetadata? = null

    /**
    * The name of the file without information on its directory path.
    */
    @ApiMember(Description="The name of the file without information on its directory path.")
    open var name:String? = null
}

/**
* 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 information about a file or directory.
*/
@Api(Description="Represents information about a file or directory.")
open class FileMetadata : IFileMetadata
{
    /**
    * The name of the file.For files, gets the name of the file.For directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.
    */
    @ApiMember(Description="The name of the file.\nFor files, gets the name of the file.\nFor directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.")
    override var name:String? = null

    /**
    * The full path of the directory or file.
    */
    @ApiMember(Description="The full path of the directory or file.")
    override var fullName:String? = null

    /**
    * The time the current file or directory was last accessed.
    */
    @ApiMember(Description="The time the current file or directory was last accessed.")
    override var lastAccessTime:Date? = null

    /**
    * The name of the file.
    */
    @ApiMember(Description="The name of the file.")
    override var lastAccessTimeUtc:Date? = null

    /**
    * The time when the current file or directory was last written to.
    */
    @ApiMember(Description="The time when the current file or directory was last written to.")
    override var lastWriteTime:Date? = null

    /**
    * The time, in coordinated universal time (UTC), when the current file or directory was last written to.
    */
    @ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.")
    override var lastWriteTimeUtc:Date? = null

    /**
    * The size, in bytes, of the current file.
    */
    @ApiMember(Description="The size, in bytes, of the current file.")
    override var length:Long? = null

    /**
    * The size, in bytes, of the current file.
    */
    @ApiMember(Description="The size, in bytes, of the current file.")
    override var userId:Int? = null

    /**
    * The file group id.
    */
    @ApiMember(Description="The file group id.")
    override var groupId:Int? = null

    /**
    * A value that indicates whether the others can read from this file.
    */
    @ApiMember(Description="A value that indicates whether the others can read from this file.")
    override var othersCanRead:Boolean? = null

    /**
    * A value that indicates whether the group members can execute this file.
    */
    @ApiMember(Description="A value that indicates whether the group members can execute this file.")
    override var groupCanExecute:Boolean? = null

    /**
    * A value that indicates whether the group members can write into this file.
    */
    @ApiMember(Description="A value that indicates whether the group members can write into this file.")
    override var groupCanWrite:Boolean? = null

    /**
    * A value that indicates whether the group members can read from this file.
    */
    @ApiMember(Description="A value that indicates whether the group members can read from this file.")
    override var groupCanRead:Boolean? = null

    /**
    * A value that indicates whether the owner can execute this file.
    */
    @ApiMember(Description="A value that indicates whether the owner can execute this file.")
    override var ownerCanExecute:Boolean? = null

    /**
    * A value that indicates whether the owner can write into this file.
    */
    @ApiMember(Description="A value that indicates whether the owner can write into this file.")
    override var ownerCanWrite:Boolean? = null

    /**
    * A value that indicates whether the owner can read from this file.
    */
    @ApiMember(Description="A value that indicates whether the owner can read from this file.")
    override var ownerCanRead:Boolean? = null

    /**
    * A value that indicates whether others can read from this file.
    */
    @ApiMember(Description="A value that indicates whether others can read from this file.")
    override var othersCanExecute:Boolean? = null

    /**
    * A value that indicates whether others can write into this file.
    */
    @ApiMember(Description="A value that indicates whether others can write into this file.")
    override var othersCanWrite:Boolean? = null

    /**
    * Extensions to the file attributes.
    */
    @ApiMember(Description="Extensions to the file attributes.")
    override var extensions:HashMap<String,String> = HashMap<String,String>()
}

/**
* Represents a type that encapsulates the return values of the ERiC API function, which retrieves the fingerprint of a specified certificate.
*/
@Api(Description="Represents a type that encapsulates the return values of the ERiC API function, which retrieves the fingerprint of a specified certificate.")
open class HoleZertifikatFingerabdruckResponse : EricFehlerCodeResponse()
{
    /**
    * The fingerprint of the return type.
    */
    @ApiMember(Description="The fingerprint of the return type.")
    open var fingerabdruck:String? = null

    /**
    * The signature of the return type.
    */
    @ApiMember(Description="The signature of the return type.")
    open var signatur:String? = 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),
}

Kotlin HoleZertifikatFingerabdruckAsync DTOs

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

HTTP + CSV

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

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

{"zertifikat":{"name":"String","pin":"String","privateKeyFile":{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="},"publicKeyFile":{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="},"checksumFile":{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="},"description":"String","tags":["String"]}}

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

{"fingerabdruck":"String","signatur":"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"}}}
© 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.