/* Options: Date: 2024-10-18 17:19:05 Version: 6.110 Tip: To override a DTO option, remove "//" prefix before updating BaseUrl: https://reportfiling.staging.pwc.de //Package: //AddServiceStackTypes: True //AddResponseStatus: False //AddImplicitVersion: //AddDescriptionAsComments: True IncludeTypes: BatchDeleteProtocolsAsync.* //ExcludeTypes: //InitializeCollections: True //TreatTypesAsStrings: //DefaultImports: java.math.*,java.util.*,net.servicestack.client.* */ import java.math.* import java.util.* import net.servicestack.client.* /** * Represents a request to search and delete protocols by using multiple search criteria in an asynchronous operation. */ @Route(Path="/async/elma/protocols/batch/delete", Verbs="POST") @Api(Description="Represents a request to search and delete protocols by using multiple search criteria in an asynchronous operation.") open class BatchDeleteProtocolsAsync : BatchDeleteProtocolsBase(), IReturn { companion object { private val responseType = DeletionResponse::class.java } override fun getResponseType(): Any? = BatchDeleteProtocolsAsync.responseType } /** * Encapsulates the results of a protocol deletion operation. */ @Api(Description="Encapsulates the results of a protocol deletion operation.") open class DeletionResponse { /** * The processing logs that form part of an ELMA response to a submitted report */ @ApiMember(Description="The processing logs that form part of an ELMA response to a submitted report", Name="Protocols") var protocols:ArrayList = ArrayList() /** * Other artefacts including the auxillary files from the BZSt. */ @ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files") var files:ArrayList = ArrayList() /** * The status of the response. */ @ApiMember(Description="The status of the response.", Name="ResponseStatus") var responseStatus:ResponseStatus? = null } /** * Represent parameters to search or filter on submissions. */ @Api(Description="Represent parameters to search or filter on submissions. ") open class SearchCriteria { /** * Full or partial name of the item (report or protocol) to search. */ @ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name") var name:String? = null /** * TThe ELMA product designation. */ @ApiMember(Description="TThe ELMA product designation.", Name="Designation") var designation:Verfahren? = null } /** * Represents the credentials of a user to authenticate the access of an ELMA server. */ @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.") open class ElmaCredential : IElmaCredential { /** * The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. */ @ApiMember(Description="The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id") var id:String? = null /** * The security certificate to authenticate the user and grant access to the ELMA server. This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start) */ @ApiMember(Description="The security certificate to authenticate the user and grant access to the ELMA server. This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)", IsRequired=true, Name="Certificate") @Required() @StringLength(2147483647) var certificate:PemCertificate? = null /** * The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */ @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer") @Required() @StringLength(11) var authSteuernummer:String? = null /** * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */ @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId") @Required() @StringLength(10) var accountId:String? = null /** * The password to protect the certificate from unauthorized access. */ @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password") var password:String? = null } open interface IAuthenticateRequest { var credential:ElmaCredential? } open interface IStageableRequest { var stagingEnabled:Boolean? } open interface IBatchSearchRequest { var searchCriteria:ArrayList? } /** * Specifies a request to search and delete protocols by using multiple search criteria. */ @Api(Description="Specifies a request to search and delete protocols by using multiple search criteria.") open class BatchDeleteProtocolsBase : IPost, IAuthenticateRequest, IStageableRequest, IBatchSearchRequest { /** * The parameters to search or filter the found protocols. */ @ApiMember(Description="The parameters to search or filter the found protocols.", IsRequired=true, Name="SearchCriteria") var searchCriteria:ArrayList = ArrayList() /** * The credential to gain access on the ELMA server. */ @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential") var credential:ElmaCredential? = null /** * Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server. */ @ApiMember(Description="Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.", Name="StagingEnabled") var stagingEnabled:Boolean? = null } /** * Represents a PEM-encoded certificate. */ @Api(Description="Represents a PEM-encoded certificate.") open class PemCertificate { /** * The unique identifier (e.g. the file name) of the certificate. */ @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id") var id:String? = null /** * The PEM-encoded content of the certificate. */ @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content") var content:String? = null /** * The description of the certificate. */ @ApiMember(Description="The description of the certificate.", Name="Description") var description:String? = null /** * Tags to label or identify the certificate. */ @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags") var tags:ArrayList = ArrayList() } /** * Represents an ELMA report document. */ @Api(Description="Represents an ELMA report document.") open class Elma { /** * The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. */ @ApiMember(Description="The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id") var id:String? = null /** * The location of the XML Schema to use for the root namespace. */ @ApiMember(Description="The location of the XML Schema to use for the root namespace.", Name="SchemaLocation") var schemaLocation:String? = null /** * The type of reporting process. */ @ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren") var verfahren:Verfahren? = null /** * The communication section of the ELMA report document. */ @ApiMember(Description="The communication section of the ELMA report document.", IsRequired=true, Name="ElmaKom") var elmaKom:ElmaKom? = null /** * The communication section of the ELMA report document. */ @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll") var elmaProtokoll:ElmaProtokoll? = null /** * The communication section of the ELMA report document. */ @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler") var elmaFehler:ElmaFehler? = null } /** * Represents a file that contains raw data content in bytes */ @Api(Description="Represents a file that contains raw data content in bytes") open class BinaryFile : FileBase() { /** * The attributes of the file. */ @ApiMember(Description="The attributes of the file.", Name="Metadata") 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.", Name="Name") var name:String? = 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.", Name="Name") var name:String? = null /** * The full path of the directory or file. */ @ApiMember(Description="The full path of the directory or file.", Name="FullName") 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.", Name="LastAccessTime") var lastAccessTime:Date? = null /** * The name of the file. */ @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc") 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.", Name="LastAccessTime") 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.", Name="LastWriteTimeUtc") var lastWriteTimeUtc:Date? = null /** * The size, in bytes, of the current file. */ @ApiMember(Description="The size, in bytes, of the current file.", Name="Length") var length:Long? = null /** * The size, in bytes, of the current file. */ @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId") var userId:Int? = null /** * The file group id. */ @ApiMember(Description="The file group id.", Name="GroupId") 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.", Name="OthersCanRead") 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.", Name="GroupCanExecute") 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.", Name="GroupCanWrite") 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.", Name="GroupCanRead") 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.", Name="OwnerCanExecute") 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.", Name="OwnerCanWrite") 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.", Name="OthersCanRead") 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.", Name="OthersCanExecute") 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.", Name="OthersCanWrite") var othersCanWrite:Boolean? = null /** * Extensions to the file attributes. */ @ApiMember(Description="Extensions to the file attributes.", Name="Extensions") var extensions:HashMap = HashMap() } enum class Verfahren { Cc, Cs, Dc, Fc, Fs, Fa, Km, } open interface IElmaCredential { var certificate:PemCertificate? var authSteuernummer:String? var accountId:String? var password:String? } /** * Represents the communication section of an ELMA report document. */ @Api(Description="Represents the communication section of an ELMA report document.") open class ElmaKom { /** * The version number of the ELMAKOM definition. */ @ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion") var elmakomVersion:String? = null /** * The header part of the ELMAKOM definition. */ @ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader") var elmaHeader:ElmaHeader? = null /** * The process part of the ELMAKOM definition. */ @ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren") var elmaVerfahren:ElmaVerfahren? = null } /** * Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report. */ @Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.") open class ElmaProtokoll { /** * File name of the processed input ELMA report. */ @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname") var dateiname:String? = null /** * The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */ @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer") var authSteuernummer:String? = null /** * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */ @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId") var accountId:String? = null /** * Date on which the request was processed by ELAN (ELMA receiving server at BZSt). */ @ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum") var verarbeitungsDatum:Date? = null /** * Time of processing by ELAN (ELMA receiving server at BZSt). */ @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit") var verarbeitungsZeit:Date? = null /** * The status code of the ELMA process. */ @ApiMember(Description="The status code of the ELMA process.", Name="Status") var status:Status? = null /** * A brief description of the status. */ @ApiMember(Description="A brief description of the status.", Name="StatusText") var statusText:String? = null /** * A detailed information on the status. */ @ApiMember(Description="A detailed information on the status.", Name="StatusDetail") var statusDetail:String? = null /** * User custom ID.This field can be filled with internal reference information of the user. */ @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId") var kundeneigeneId:String? = null /** * Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */ @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID") var uuid:UUID? = null } /** * Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report. */ @Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.") open class ElmaFehler { /** * File name of the processed input ELMA report. */ @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname") var dateiname:String? = null /** * The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */ @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer") var authSteuernummer:String? = null /** * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */ @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId") var accountId:String? = null /** * Date on which the request was processed by ELAN (ELMA receiving server at BZSt). */ @ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum") var verarbeitungsDatum:Date? = null /** * Time of processing by ELAN (ELMA receiving server at BZSt). */ @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit") var verarbeitungsZeit:Date? = null /** * The status code of the ELMA process. */ @ApiMember(Description="The status code of the ELMA process.", Name="FehlerID") var fehlerID:Status? = null /** * A brief description of the error status. */ @ApiMember(Description="A brief description of the error status.", Name="FehlerText") var fehlerText:String? = null /** * A detailed information on the status. */ @ApiMember(Description="A detailed information on the status.", Name="FehlerProzess") var fehlerProzess:String? = null /** * User custom ID.This field can be filled with internal reference information of the user. */ @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId") var kundeneigeneId:String? = null /** * Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */ @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID") var uuid:UUID? = 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. */ @ApiMember(Description="The raw data content of the file.", Name="Content") var content:ByteArray? = null } open interface IFileMetadata { var name:String? var fullName:String? var lastAccessTime:Date? var lastAccessTimeUtc:Date? var lastWriteTime:Date? var lastWriteTimeUtc:Date? var length:Long? var userId:Int? var groupId:Int? var groupCanExecute:Boolean? var groupCanWrite:Boolean? var groupCanRead:Boolean? var ownerCanRead:Boolean? var ownerCanExecute:Boolean? var ownerCanWrite:Boolean? var othersCanRead:Boolean? var othersCanExecute:Boolean? var othersCanWrite:Boolean? var extensions:HashMap? } /** * Represents the header of an ELMA communication section. */ @Api(Description="Represents the header of an ELMA communication section.") open class ElmaHeader { /** * The process-specific report type of an ELMA document.It distinguishes by the type of input. */ @ApiMember(Description="The process-specific report type of an ELMA document.It distinguishes by the type of input.", IsRequired=true, Name="DatenArt") var datenArt:DatenArt? = null /** * The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */ @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer") var authSteuernummer:String? = null /** * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */ @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId") var accountId:String? = null /** * The time of creation.Corresponds to the time, at which the user created a file. */ @ApiMember(Description="The time of creation.Corresponds to the time, at which the user created a file.", Name="ErstellungsDatum") var erstellungsDatum:Date? = null /** * User custom ID.This field can be filled with internal reference information of the user. */ @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId") var kundeneigeneId:String? = null /** * Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */ @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID") var uuid:UUID? = null /** * Distinguishes between test and live data transfer. */ @ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf") var verarbeitungslauf:Verarbeitungslauf? = null } open class ElmaVerfahren { /** * The content of process-specific definition. */ @ApiMember(Description="The content of process-specific definition.", Name="Inhalt") var inhalt:Object? = null } enum class Status(val value:Int) { ElmaGlobalUnbekannt(0), ElmaOk(8000), ElmaParserFehler(8001), ElmaUngueltigeKodierung(8002), ElmaUngueltigeDateiname(8003), ElmaFalscheBzstnrOderAccountid(8004), ElmaSignaturDateiFehlt(8005), ElmaSignaturPruefungFehlerhaft(8006), ElmaNotwendigeFachlicheBerechtigungenFehlen(8007), ElmaFreischaltungFehlt(8008), ElmaSperreVorhanden(8009), ElmaDateinameBereitsVerwendet(8010), ElmaDateiinhaltIdentisch(8011), ElmaBzstnrOderAccountidStimmtNichtUberein(8012), ElmaTestdaten(8013), } enum class DatenArt { ElmaCc, ElmaCcrm, ElmaCrs, ElmaCrsrm, ElmaDc, ElmaDcrm, ElmaFc, ElmaFcrm, } enum class Verarbeitungslauf { Produktionslauf, Testlauf, }