Report Filing Service
| POST | /sync/elma/protocols/batch/retrieve |
|---|
namespace PwC.DigitalHub.Utilities.IO.Concretes.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type Verfahren =
| CC = 0
| CS = 1
| DC = 2
| FC = 3
| FS = 4
| FA = 5
| KM = 6
type DatenArt =
| ELMA_CC = 0
| ELMA_CCRM = 1
| ELMA_CRS = 2
| ELMA_CRSRM = 3
| ELMA_DC = 4
| ELMA_DCRM = 5
| ELMA_FC = 6
| ELMA_FCRM = 7
type Verarbeitungslauf =
| PRODUKTIONSLAUF = 0
| TESTLAUF = 1
///<summary>
///Represents the header of an ELMA communication section.
///</summary>
[<Api(Description="Represents the header of an ELMA communication section.")>]
[<AllowNullLiteral>]
type ElmaHeader() =
///<summary>
///The process-specific report type of an ELMA document.It distinguishes by the type of input.
///</summary>
[<ApiMember(Description="The process-specific report type of an ELMA document.It distinguishes by the type of input.", IsRequired=true, Name="DatenArt")>]
member val DatenArt:DatenArt = new DatenArt() with get,set
///<summary>
///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"
///</summary>
[<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")>]
member val AuthSteuernummer:String = null with get,set
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[<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")>]
member val AccountId:String = null with get,set
///<summary>
///The time of creation.Corresponds to the time, at which the user created a file.
///</summary>
[<ApiMember(Description="The time of creation.Corresponds to the time, at which the user created a file.", Name="ErstellungsDatum")>]
member val ErstellungsDatum:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///User custom ID.This field can be filled with internal reference information of the user.
///</summary>
[<ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")>]
member val KundeneigeneId:String = null with get,set
///<summary>
///Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
///</summary>
[<ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")>]
member val UUID:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Distinguishes between test and live data transfer.
///</summary>
[<ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf")>]
member val Verarbeitungslauf:Verarbeitungslauf = new Verarbeitungslauf() with get,set
[<AllowNullLiteral>]
type ElmaVerfahren() =
///<summary>
///The content of process-specific definition.
///</summary>
[<ApiMember(Description="The content of process-specific definition.", Name="Inhalt")>]
member val Inhalt:Object = null with get,set
///<summary>
///Represents the communication section of an ELMA report document.
///</summary>
[<Api(Description="Represents the communication section of an ELMA report document.")>]
[<AllowNullLiteral>]
type ElmaKom() =
///<summary>
///The version number of the ELMAKOM definition.
///</summary>
[<ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion")>]
member val ElmakomVersion:String = null with get,set
///<summary>
///The header part of the ELMAKOM definition.
///</summary>
[<ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader")>]
member val ElmaHeader:ElmaHeader = null with get,set
///<summary>
///The process part of the ELMAKOM definition.
///</summary>
[<ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren")>]
member val ElmaVerfahren:ElmaVerfahren = null with get,set
type Status =
| ELMA_GLOBAL_UNBEKANNT = 0
| ELMA_OK = 8000
| ELMA_PARSER_FEHLER = 8001
| ELMA_UNGUELTIGE_KODIERUNG = 8002
| ELMA_UNGUELTIGE_DATEINAME = 8003
| ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID = 8004
| ELMA_SIGNATUR_DATEI_FEHLT = 8005
| ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT = 8006
| ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN = 8007
| ELMA_FREISCHALTUNG_FEHLT = 8008
| ELMA_SPERRE_VORHANDEN = 8009
| ELMA_DATEINAME_BEREITS_VERWENDET = 8010
| ELMA_DATEIINHALT_IDENTISCH = 8011
| ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN = 8012
| ELMA_TESTDATEN = 8013
///<summary>
///Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
///</summary>
[<Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")>]
[<AllowNullLiteral>]
type ElmaProtokoll() =
///<summary>
///File name of the processed input ELMA report.
///</summary>
[<ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")>]
member val Dateiname:String = null with get,set
///<summary>
///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"
///</summary>
[<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")>]
member val AuthSteuernummer:String = null with get,set
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[<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")>]
member val AccountId:String = null with get,set
///<summary>
///Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
///</summary>
[<ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")>]
member val VerarbeitungsDatum:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Time of processing by ELAN (ELMA receiving server at BZSt).
///</summary>
[<ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")>]
member val VerarbeitungsZeit:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The status code of the ELMA process.
///</summary>
[<ApiMember(Description="The status code of the ELMA process.", Name="Status")>]
member val Status:Status = new Status() with get,set
///<summary>
///A brief description of the status.
///</summary>
[<ApiMember(Description="A brief description of the status.", Name="StatusText")>]
member val StatusText:String = null with get,set
///<summary>
///A detailed information on the status.
///</summary>
[<ApiMember(Description="A detailed information on the status.", Name="StatusDetail")>]
member val StatusDetail:String = null with get,set
///<summary>
///User custom ID.This field can be filled with internal reference information of the user.
///</summary>
[<ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")>]
member val KundeneigeneId:String = null with get,set
///<summary>
///Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
///</summary>
[<ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")>]
member val UUID:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
///</summary>
[<Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")>]
[<AllowNullLiteral>]
type ElmaFehler() =
///<summary>
///File name of the processed input ELMA report.
///</summary>
[<ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")>]
member val Dateiname:String = null with get,set
///<summary>
///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"
///</summary>
[<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")>]
member val AuthSteuernummer:String = null with get,set
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[<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")>]
member val AccountId:String = null with get,set
///<summary>
///Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
///</summary>
[<ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")>]
member val VerarbeitungsDatum:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Time of processing by ELAN (ELMA receiving server at BZSt).
///</summary>
[<ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")>]
member val VerarbeitungsZeit:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The status code of the ELMA process.
///</summary>
[<ApiMember(Description="The status code of the ELMA process.", Name="FehlerID")>]
member val FehlerID:Status = new Status() with get,set
///<summary>
///A brief description of the error status.
///</summary>
[<ApiMember(Description="A brief description of the error status.", Name="FehlerText")>]
member val FehlerText:String = null with get,set
///<summary>
///A detailed information on the status.
///</summary>
[<ApiMember(Description="A detailed information on the status.", Name="FehlerProzess")>]
member val FehlerProzess:String = null with get,set
///<summary>
///User custom ID.This field can be filled with internal reference information of the user.
///</summary>
[<ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")>]
member val KundeneigeneId:String = null with get,set
///<summary>
///Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
///</summary>
[<ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")>]
member val UUID:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Represents an ELMA report document.
///</summary>
[<Api(Description="Represents an ELMA report document.")>]
[<AllowNullLiteral>]
type Elma() =
///<summary>
///The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
///</summary>
[<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")>]
member val Id:String = null with get,set
///<summary>
///The location of the XML Schema to use for the root namespace.
///</summary>
[<ApiMember(Description="The location of the XML Schema to use for the root namespace.", Name="SchemaLocation")>]
member val SchemaLocation:String = null with get,set
///<summary>
///The type of reporting process.
///</summary>
[<ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren")>]
member val Verfahren:Nullable<Verfahren> = new Nullable<Verfahren>() with get,set
///<summary>
///The communication section of the ELMA report document.
///</summary>
[<ApiMember(Description="The communication section of the ELMA report document.", IsRequired=true, Name="ElmaKom")>]
member val ElmaKom:ElmaKom = null with get,set
///<summary>
///The communication section of the ELMA report document.
///</summary>
[<ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll")>]
member val ElmaProtokoll:ElmaProtokoll = null with get,set
///<summary>
///The communication section of the ELMA report document.
///</summary>
[<ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler")>]
member val ElmaFehler:ElmaFehler = null with get,set
///<summary>
///Represents a base class for a file with raw data.
///</summary>
[<Api(Description="Represents a base class for a file with raw data.")>]
[<AllowNullLiteral>]
type FileBase() =
///<summary>
///The raw data content of the file.
///</summary>
[<ApiMember(Description="The raw data content of the file.", Name="Content")>]
member val Content:Byte[] = [||] with get,set
///<summary>
///Represents information about a file or directory.
///</summary>
[<Api(Description="Represents information about a file or directory.")>]
[<AllowNullLiteral>]
type FileMetadata() =
///<summary>
///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.
///</summary>
[<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")>]
member val Name:String = null with get,set
///<summary>
///The full path of the directory or file.
///</summary>
[<ApiMember(Description="The full path of the directory or file.", Name="FullName")>]
member val FullName:String = null with get,set
///<summary>
///The time the current file or directory was last accessed.
///</summary>
[<ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")>]
member val LastAccessTime:DateTime = new DateTime() with get,set
///<summary>
///The name of the file.
///</summary>
[<ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")>]
member val LastAccessTimeUtc:DateTime = new DateTime() with get,set
///<summary>
///The time when the current file or directory was last written to.
///</summary>
[<ApiMember(Description="The time when the current file or directory was last written to.", Name="LastAccessTime")>]
member val LastWriteTime:DateTime = new DateTime() with get,set
///<summary>
///The time, in coordinated universal time (UTC), when the current file or directory was last written to.
///</summary>
[<ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.", Name="LastWriteTimeUtc")>]
member val LastWriteTimeUtc:DateTime = new DateTime() with get,set
///<summary>
///The size, in bytes, of the current file.
///</summary>
[<ApiMember(Description="The size, in bytes, of the current file.", Name="Length")>]
member val Length:Int64 = new Int64() with get,set
///<summary>
///The size, in bytes, of the current file.
///</summary>
[<ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")>]
member val UserId:Int32 = new Int32() with get,set
///<summary>
///The file group id.
///</summary>
[<ApiMember(Description="The file group id.", Name="GroupId")>]
member val GroupId:Int32 = new Int32() with get,set
///<summary>
///A value that indicates whether the others can read from this file.
///</summary>
[<ApiMember(Description="A value that indicates whether the others can read from this file.", Name="OthersCanRead")>]
member val OthersCanRead:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether the group members can execute this file.
///</summary>
[<ApiMember(Description="A value that indicates whether the group members can execute this file.", Name="GroupCanExecute")>]
member val GroupCanExecute:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether the group members can write into this file.
///</summary>
[<ApiMember(Description="A value that indicates whether the group members can write into this file.", Name="GroupCanWrite")>]
member val GroupCanWrite:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether the group members can read from this file.
///</summary>
[<ApiMember(Description="A value that indicates whether the group members can read from this file.", Name="GroupCanRead")>]
member val GroupCanRead:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether the owner can execute this file.
///</summary>
[<ApiMember(Description="A value that indicates whether the owner can execute this file.", Name="OwnerCanExecute")>]
member val OwnerCanExecute:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether the owner can write into this file.
///</summary>
[<ApiMember(Description="A value that indicates whether the owner can write into this file.", Name="OwnerCanWrite")>]
member val OwnerCanWrite:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether the owner can read from this file.
///</summary>
[<ApiMember(Description="A value that indicates whether the owner can read from this file.", Name="OthersCanRead")>]
member val OwnerCanRead:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether others can read from this file.
///</summary>
[<ApiMember(Description="A value that indicates whether others can read from this file.", Name="OthersCanExecute")>]
member val OthersCanExecute:Boolean = new Boolean() with get,set
///<summary>
///A value that indicates whether others can write into this file.
///</summary>
[<ApiMember(Description="A value that indicates whether others can write into this file.", Name="OthersCanWrite")>]
member val OthersCanWrite:Boolean = new Boolean() with get,set
///<summary>
///Extensions to the file attributes.
///</summary>
[<ApiMember(Description="Extensions to the file attributes.", Name="Extensions")>]
member val Extensions:Dictionary<String, String> = new Dictionary<String, String>() with get,set
///<summary>
///Represents a file that contains raw data content in bytes
///</summary>
[<Api(Description="Represents a file that contains raw data content in bytes")>]
[<AllowNullLiteral>]
type BinaryFile() =
inherit FileBase()
///<summary>
///The attributes of the file.
///</summary>
[<ApiMember(Description="The attributes of the file.", Name="Metadata")>]
member val Metadata:FileMetadata = null with get,set
///<summary>
///The name of the file without information on its directory path.
///</summary>
[<ApiMember(Description="The name of the file without information on its directory path.", Name="Name")>]
member val Name:String = null with get,set
///<summary>
///Encapsulates the results of a protocol retrieval operation.
///</summary>
[<Api(Description="Encapsulates the results of a protocol retrieval operation.")>]
[<AllowNullLiteral>]
type RetrievalResponse() =
///<summary>
///Processing logs that indicate the status of submitted reports.
///</summary>
[<ApiMember(Description="Processing logs that indicate the status of submitted reports.", Name="Protocols")>]
member val Protocols:ResizeArray<Elma> = new ResizeArray<Elma>() with get,set
///<summary>
///Other artefacts including the auxillary files from the BZSt.
///</summary>
[<ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files")>]
member val Files:ResizeArray<BinaryFile> = new ResizeArray<BinaryFile>() with get,set
///<summary>
///The status of the response.
///</summary>
[<ApiMember(Description="The status of the response.", Name="ResponseStatus")>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Represent parameters to search or filter on submissions.
///</summary>
[<Api(Description="Represent parameters to search or filter on submissions. ")>]
[<AllowNullLiteral>]
type SearchCriteria() =
///<summary>
///Full or partial name of the item (report or protocol) to search.
///</summary>
[<ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name")>]
member val Name:String = null with get,set
///<summary>
///TThe ELMA product designation.
///</summary>
[<ApiMember(Description="TThe ELMA product designation.", Name="Designation")>]
member val Designation:Nullable<Verfahren> = new Nullable<Verfahren>() with get,set
///<summary>
///Represents a PEM-encoded certificate.
///</summary>
[<Api(Description="Represents a PEM-encoded certificate.")>]
[<AllowNullLiteral>]
type PemCertificate() =
///<summary>
///The unique identifier (e.g. the file name) of the certificate.
///</summary>
[<ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")>]
member val Id:String = null with get,set
///<summary>
///The PEM-encoded content of the certificate.
///</summary>
[<ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")>]
member val Content:String = null with get,set
///<summary>
///The description of the certificate.
///</summary>
[<ApiMember(Description="The description of the certificate.", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Tags to label or identify the certificate.
///</summary>
[<ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")>]
member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Represents the credentials of a user to authenticate the access of an ELMA server.
///</summary>
[<Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")>]
[<AllowNullLiteral>]
type ElmaCredential() =
///<summary>
///The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
///</summary>
[<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")>]
member val Id:String = null with get,set
///<summary>
///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)
///</summary>
[<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(Int32.MaxValue)>]
member val Certificate:PemCertificate = null with get,set
///<summary>
///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"
///</summary>
[<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)>]
member val AuthSteuernummer:String = null with get,set
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[<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)>]
member val AccountId:String = null with get,set
///<summary>
///The password to protect the certificate from unauthorized access.
///</summary>
[<ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")>]
member val Password:String = null with get,set
///<summary>
///Specifies a request to retrieve protocols using multiple search criteria.
///</summary>
[<Api(Description="Specifies a request to retrieve protocols using multiple search criteria.")>]
[<AllowNullLiteral>]
type BatchRetrieveProtocolsBase() =
interface IPost
///<summary>
///The parameters to search or filter the found protocols.
///</summary>
[<ApiMember(Description="The parameters to search or filter the found protocols.", IsRequired=true, Name="SearchCriteria")>]
member val SearchCriteria:ResizeArray<SearchCriteria> = new ResizeArray<SearchCriteria>() with get,set
///<summary>
///The credential to gain access on the ELMA server.
///</summary>
[<ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")>]
member val Credential:ElmaCredential = null with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val StagingEnabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Represents a request to retrieve protocols using multiple search criteria.
///</summary>
[<Api(Description="Represents a request to retrieve protocols using multiple search criteria.")>]
[<AllowNullLiteral>]
type BatchRetrieveProtocols() =
inherit BatchRetrieveProtocolsBase()
F# BatchRetrieveProtocols DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/elma/protocols/batch/retrieve HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchRetrieveProtocols xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Requests">
<Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
<d2p1:Certificate xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
<d3p1:Content>String</d3p1:Content>
<d3p1:Description>String</d3p1:Description>
<d3p1:Id>String</d3p1:Id>
<d3p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d3p1:Tags>
</d2p1:Certificate>
<d2p1:Password>String</d2p1:Password>
</Credential>
<SearchCriteria>
<SearchCriteria>
<Designation>CC</Designation>
<Name>String</Name>
</SearchCriteria>
</SearchCriteria>
<StagingEnabled>false</StagingEnabled>
</BatchRetrieveProtocols>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RetrievalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
<Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Concretes.Models">
<d2p1:BinaryFile>
<Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
<d2p1:Metadata xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Concretes.Models">
<d4p1:Extensions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d4p1:Extensions>
<d4p1:FullName>String</d4p1:FullName>
<d4p1:GroupCanExecute>false</d4p1:GroupCanExecute>
<d4p1:GroupCanRead>false</d4p1:GroupCanRead>
<d4p1:GroupCanWrite>false</d4p1:GroupCanWrite>
<d4p1:GroupId>0</d4p1:GroupId>
<d4p1:LastAccessTime>0001-01-01T00:00:00</d4p1:LastAccessTime>
<d4p1:LastAccessTimeUtc>0001-01-01T00:00:00</d4p1:LastAccessTimeUtc>
<d4p1:LastWriteTime>0001-01-01T00:00:00</d4p1:LastWriteTime>
<d4p1:LastWriteTimeUtc>0001-01-01T00:00:00</d4p1:LastWriteTimeUtc>
<d4p1:Length>0</d4p1:Length>
<d4p1:Name>String</d4p1:Name>
<d4p1:OthersCanExecute>false</d4p1:OthersCanExecute>
<d4p1:OthersCanRead>false</d4p1:OthersCanRead>
<d4p1:OthersCanWrite>false</d4p1:OthersCanWrite>
<d4p1:OwnerCanExecute>false</d4p1:OwnerCanExecute>
<d4p1:OwnerCanRead>false</d4p1:OwnerCanRead>
<d4p1:OwnerCanWrite>false</d4p1:OwnerCanWrite>
<d4p1:UserId>0</d4p1:UserId>
</d2p1:Metadata>
<d2p1:Name>String</d2p1:Name>
</d2p1:BinaryFile>
</Files>
<Protocols xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
<d2p1:Elma xmlns:n1="http://www.itzbund.de/ELAN/01">
<n1:ELMAKOM ELMAKOMVersion="String">
<n1:ELMAHeader>
<n1:DatenArt>ELMA_CC</n1:DatenArt>
<n1:AuthSteuernummer>String</n1:AuthSteuernummer>
<n1:AccountID>String</n1:AccountID>
<n1:ErstellungsDatum>0001-01-01T00:00:00.000</n1:ErstellungsDatum>
<n1:KundeneigeneID>String</n1:KundeneigeneID>
<n1:UUID>00000000-0000-0000-0000-000000000000</n1:UUID>
<n1:Verarbeitungslauf>PRODUKTIONSLAUF</n1:Verarbeitungslauf>
</n1:ELMAHeader>
<n1:ELMAVerfahren />
</n1:ELMAKOM>
<n1:ELMAProtokoll>
<n1:Dateiname>String</n1:Dateiname>
<n1:AuthSteuernummer>String</n1:AuthSteuernummer>
<n1:AccountID>String</n1:AccountID>
<n1:VerarbeitungsDatum>0001-01-01</n1:VerarbeitungsDatum>
<n1:VerarbeitungsZeit>0001-01-01</n1:VerarbeitungsZeit>
<n1:Status>ELMA_GLOBAL_UNBEKANNT</n1:Status>
<n1:StatusText>String</n1:StatusText>
<n1:StatusDetail>String</n1:StatusDetail>
<n1:KundeneigeneID>String</n1:KundeneigeneID>
<n1:UUID>00000000-0000-0000-0000-000000000000</n1:UUID>
</n1:ELMAProtokoll>
<n1:ELMAFEHLER>
<n1:Dateiname>String</n1:Dateiname>
<n1:AuthSteuernummer>String</n1:AuthSteuernummer>
<n1:AccountID>String</n1:AccountID>
<n1:VerarbeitungsDatum>0001-01-01</n1:VerarbeitungsDatum>
<n1:VerarbeitungsZeit>00:00:00.000</n1:VerarbeitungsZeit>
<n1:FehlerID>ELMA_GLOBAL_UNBEKANNT</n1:FehlerID>
<n1:FehlerText>String</n1:FehlerText>
<n1:FehlerProzess>String</n1:FehlerProzess>
<n1:KundeneigeneID>String</n1:KundeneigeneID>
<n1:UUID>00000000-0000-0000-0000-000000000000</n1:UUID>
</n1:ELMAFEHLER>
</d2p1:Elma>
</Protocols>
<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>
</RetrievalResponse>