Report Filing Service
| POST | /async/elma/dac6/protocols/batch/retrieve |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class Verfahren(str, Enum):
CC = 'CC'
CS = 'CS'
DC = 'DC'
FC = 'FC'
FS = 'FS'
FA = 'FA'
KM = 'KM'
# @Api(Description="Represent parameters to search or filter on submissions. ")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchCriteria:
"""
Represent parameters to search or filter on submissions.
"""
# @ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name")
name: Optional[str] = None
"""
Full or partial name of the item (report or protocol) to search.
"""
# @ApiMember(Description="TThe ELMA product designation.", Name="Designation")
designation: Optional[Verfahren] = None
"""
TThe ELMA product designation.
"""
# @Api(Description="Represents a PEM-encoded certificate.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PemCertificate:
"""
Represents a PEM-encoded certificate.
"""
# @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
id: Optional[str] = None
"""
The unique identifier (e.g. the file name) of the certificate.
"""
# @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
content: Optional[str] = None
"""
The PEM-encoded content of the certificate.
"""
# @ApiMember(Description="The description of the certificate.", Name="Description")
description: Optional[str] = None
"""
The description of the certificate.
"""
# @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
tags: Optional[List[str]] = None
"""
Tags to label or identify the certificate.
"""
# @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElmaCredential(IElmaCredential):
"""
Represents the credentials of a user to authenticate the access of an ELMA server.
"""
# @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")
id: Optional[str] = None
"""
The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
"""
# @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)
certificate: Optional[PemCertificate] = None
"""
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 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)
auth_steuernummer: Optional[str] = None
"""
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 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)
account_id: Optional[str] = None
"""
The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
"""
# @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
password: Optional[str] = None
"""
The password to protect the certificate from unauthorized access.
"""
# @Api(Description="Specifies a request to retrieve protocols of submitted DAC6 reports.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchRetrieveDac6ProtocolsBase(IReturn[RetrievalResponse], IPost, IAuthenticateRequest, IStageableRequest, IBatchSearchRequest):
"""
Specifies a request to retrieve protocols of submitted DAC6 reports.
"""
# @ApiMember(Description="The parameters to search or filter the found protocols.", IsRequired=true, Name="SearchCriteria")
search_criteria: Optional[List[SearchCriteria]] = None
"""
The parameters to search or filter the found protocols.
"""
# @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
credential: Optional[ElmaCredential] = None
"""
The credential to gain access on the 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")
staging_enabled: Optional[bool] = None
"""
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.
"""
@staticmethod
def response_type(): return RetrievalResponse
class DatenArt(str, Enum):
ELM_A__C_C = 'ELMA_CC'
ELM_A__C_C_R_M = 'ELMA_CCRM'
ELM_A__C_R_S = 'ELMA_CRS'
ELM_A__C_R_S_R_M = 'ELMA_CRSRM'
ELM_A__D_C = 'ELMA_DC'
ELM_A__D_C_R_M = 'ELMA_DCRM'
ELM_A__F_C = 'ELMA_FC'
ELM_A__F_C_R_M = 'ELMA_FCRM'
class Verarbeitungslauf(str, Enum):
PRODUKTIONSLAUF = 'PRODUKTIONSLAUF'
TESTLAUF = 'TESTLAUF'
# @Api(Description="Represents the header of an ELMA communication section.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElmaHeader:
"""
Represents the header of an ELMA communication section.
"""
# @ApiMember(Description="The process-specific report type of an ELMA document.It distinguishes by the type of input.", IsRequired=true, Name="DatenArt")
daten_art: Optional[DatenArt] = None
"""
The process-specific report type of an ELMA document.It distinguishes by the type of input.
"""
# @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")
auth_steuernummer: Optional[str] = None
"""
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 account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
account_id: Optional[str] = None
"""
The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
"""
# @ApiMember(Description="The time of creation.Corresponds to the time, at which the user created a file.", Name="ErstellungsDatum")
erstellungs_datum: Optional[datetime.datetime] = None
"""
The time of creation.Corresponds to the time, at which the user created a file.
"""
# @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")
kundeneigene_id: Optional[str] = None
"""
User custom ID.This field can be filled with internal reference information of the user.
"""
# @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")
uuid: Optional[str] = None
"""
Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
"""
# @ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf")
verarbeitungslauf: Optional[Verarbeitungslauf] = None
"""
Distinguishes between test and live data transfer.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElmaVerfahren:
# @ApiMember(Description="The content of process-specific definition.", Name="Inhalt")
inhalt: Optional[Object] = None
"""
The content of process-specific definition.
"""
# @Api(Description="Represents the communication section of an ELMA report document.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElmaKom:
"""
Represents the communication section of an ELMA report document.
"""
# @ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion")
elmakom_version: Optional[str] = None
"""
The version number of the ELMAKOM definition.
"""
# @ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader")
elma_header: Optional[ElmaHeader] = None
"""
The header part of the ELMAKOM definition.
"""
# @ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren")
elma_verfahren: Optional[ElmaVerfahren] = None
"""
The process part of the ELMAKOM definition.
"""
class Status(IntEnum):
ELM_A__G_L_O_B_A_L__U_N_B_E_K_A_N_N_T = 0
ELM_A__O_K = 8000
ELM_A__P_A_R_S_E_R__F_E_H_L_E_R = 8001
ELM_A__U_N_G_U_E_L_T_I_G_E__K_O_D_I_E_R_U_N_G = 8002
ELM_A__U_N_G_U_E_L_T_I_G_E__D_A_T_E_I_N_A_M_E = 8003
ELM_A__F_A_L_S_C_H_E__B_Z_S_T_N_R__O_D_E_R__A_C_C_O_U_N_T_I_D = 8004
ELM_A__S_I_G_N_A_T_U_R__D_A_T_E_I__F_E_H_L_T = 8005
ELM_A__S_I_G_N_A_T_U_R__P_R_U_E_F_U_N_G__F_E_H_L_E_R_H_A_F_T = 8006
ELM_A__N_O_T_W_E_N_D_I_G_E__F_A_C_H_L_I_C_H_E__B_E_R_E_C_H_T_I_G_U_N_G_E_N__F_E_H_L_E_N = 8007
ELM_A__F_R_E_I_S_C_H_A_L_T_U_N_G__F_E_H_L_T = 8008
ELM_A__S_P_E_R_R_E__V_O_R_H_A_N_D_E_N = 8009
ELM_A__D_A_T_E_I_N_A_M_E__B_E_R_E_I_T_S__V_E_R_W_E_N_D_E_T = 8010
ELM_A__D_A_T_E_I_I_N_H_A_L_T__I_D_E_N_T_I_S_C_H = 8011
ELM_A__B_Z_S_T_N_R__O_D_E_R__A_C_C_O_U_N_T_I_D__S_T_I_M_M_T__N_I_C_H_T__U_B_E_R_E_I_N = 8012
ELM_A__T_E_S_T_D_A_T_E_N = 8013
# @Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElmaProtokoll:
"""
Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
"""
# @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
dateiname: Optional[str] = None
"""
File name of the processed input ELMA report.
"""
# @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")
auth_steuernummer: Optional[str] = None
"""
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 account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
account_id: Optional[str] = None
"""
The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
"""
# @ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")
verarbeitungs_datum: Optional[datetime.datetime] = None
"""
Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
"""
# @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")
verarbeitungs_zeit: Optional[datetime.datetime] = None
"""
Time of processing by ELAN (ELMA receiving server at BZSt).
"""
# @ApiMember(Description="The status code of the ELMA process.", Name="Status")
status: Optional[Status] = None
"""
The status code of the ELMA process.
"""
# @ApiMember(Description="A brief description of the status.", Name="StatusText")
status_text: Optional[str] = None
"""
A brief description of the status.
"""
# @ApiMember(Description="A detailed information on the status.", Name="StatusDetail")
status_detail: Optional[str] = None
"""
A detailed information on the status.
"""
# @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")
kundeneigene_id: Optional[str] = None
"""
User custom ID.This field can be filled with internal reference information of the user.
"""
# @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")
uuid: Optional[str] = None
"""
Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
"""
# @Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElmaFehler:
"""
Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
"""
# @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
dateiname: Optional[str] = None
"""
File name of the processed input ELMA report.
"""
# @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")
auth_steuernummer: Optional[str] = None
"""
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 account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
account_id: Optional[str] = None
"""
The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
"""
# @ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")
verarbeitungs_datum: Optional[datetime.datetime] = None
"""
Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
"""
# @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")
verarbeitungs_zeit: Optional[datetime.datetime] = None
"""
Time of processing by ELAN (ELMA receiving server at BZSt).
"""
# @ApiMember(Description="The status code of the ELMA process.", Name="FehlerID")
fehler_i_d: Optional[Status] = None
"""
The status code of the ELMA process.
"""
# @ApiMember(Description="A brief description of the error status.", Name="FehlerText")
fehler_text: Optional[str] = None
"""
A brief description of the error status.
"""
# @ApiMember(Description="A detailed information on the status.", Name="FehlerProzess")
fehler_prozess: Optional[str] = None
"""
A detailed information on the status.
"""
# @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")
kundeneigene_id: Optional[str] = None
"""
User custom ID.This field can be filled with internal reference information of the user.
"""
# @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")
uuid: Optional[str] = None
"""
Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
"""
# @Api(Description="Represents an ELMA report document.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Elma:
"""
Represents an ELMA report document.
"""
# @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")
id: Optional[str] = None
"""
The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
"""
# @ApiMember(Description="The location of the XML Schema to use for the root namespace.", Name="SchemaLocation")
schema_location: Optional[str] = None
"""
The location of the XML Schema to use for the root namespace.
"""
# @ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren")
verfahren: Optional[Verfahren] = None
"""
The type of reporting process.
"""
# @ApiMember(Description="The communication section of the ELMA report document.", IsRequired=true, Name="ElmaKom")
elma_kom: Optional[ElmaKom] = None
"""
The communication section of the ELMA report document.
"""
# @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll")
elma_protokoll: Optional[ElmaProtokoll] = None
"""
The communication section of the ELMA report document.
"""
# @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler")
elma_fehler: Optional[ElmaFehler] = None
"""
The communication section of the ELMA report document.
"""
# @Api(Description="Represents a base class for a file with raw data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileBase:
"""
Represents a base class for a file with raw data.
"""
# @ApiMember(Description="The raw data content of the file.", Name="Content")
content: Optional[bytes] = None
"""
The raw data content of the file.
"""
# @Api(Description="Represents information about a file or directory.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileMetadata(IFileMetadata):
"""
Represents information about a file or 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")
name: Optional[str] = None
"""
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 full path of the directory or file.", Name="FullName")
full_name: Optional[str] = None
"""
The full path of the directory or file.
"""
# @ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")
last_access_time: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The time the current file or directory was last accessed.
"""
# @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
last_access_time_utc: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The name of the file.
"""
# @ApiMember(Description="The time when the current file or directory was last written to.", Name="LastAccessTime")
last_write_time: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The time 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")
last_write_time_utc: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The time, in coordinated universal time (UTC), when the current file or directory was last written to.
"""
# @ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
length: int = 0
"""
The size, in bytes, of the current file.
"""
# @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
user_id: int = 0
"""
The size, in bytes, of the current file.
"""
# @ApiMember(Description="The file group id.", Name="GroupId")
group_id: int = 0
"""
The file group id.
"""
# @ApiMember(Description="A value that indicates whether the others can read from this file.", Name="OthersCanRead")
others_can_read: bool = False
"""
A value that indicates whether the others can read from this file.
"""
# @ApiMember(Description="A value that indicates whether the group members can execute this file.", Name="GroupCanExecute")
group_can_execute: bool = False
"""
A value that indicates whether the group members can execute this file.
"""
# @ApiMember(Description="A value that indicates whether the group members can write into this file.", Name="GroupCanWrite")
group_can_write: bool = False
"""
A value that indicates whether the group members can write into this file.
"""
# @ApiMember(Description="A value that indicates whether the group members can read from this file.", Name="GroupCanRead")
group_can_read: bool = False
"""
A value that indicates whether the group members can read from this file.
"""
# @ApiMember(Description="A value that indicates whether the owner can execute this file.", Name="OwnerCanExecute")
owner_can_execute: bool = False
"""
A value that indicates whether the owner can execute this file.
"""
# @ApiMember(Description="A value that indicates whether the owner can write into this file.", Name="OwnerCanWrite")
owner_can_write: bool = False
"""
A value that indicates whether the owner can write into this file.
"""
# @ApiMember(Description="A value that indicates whether the owner can read from this file.", Name="OthersCanRead")
owner_can_read: bool = False
"""
A value that indicates whether the owner can read from this file.
"""
# @ApiMember(Description="A value that indicates whether others can read from this file.", Name="OthersCanExecute")
others_can_execute: bool = False
"""
A value that indicates whether others can read from this file.
"""
# @ApiMember(Description="A value that indicates whether others can write into this file.", Name="OthersCanWrite")
others_can_write: bool = False
"""
A value that indicates whether others can write into this file.
"""
# @ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
extensions: Optional[Dict[str, str]] = None
"""
Extensions to the file attributes.
"""
# @Api(Description="Represents a file that contains raw data content in bytes")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BinaryFile(FileBase):
"""
Represents a file that contains raw data content in bytes
"""
# @ApiMember(Description="The attributes of the file.", Name="Metadata")
metadata: Optional[FileMetadata] = None
"""
The attributes of the file.
"""
# @ApiMember(Description="The name of the file without information on its directory path.", Name="Name")
name: Optional[str] = None
"""
The name of the file without information on its directory path.
"""
# @Api(Description="Encapsulates the results of a protocol retrieval operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrievalResponse:
"""
Encapsulates the results of a protocol retrieval operation.
"""
# @ApiMember(Description="Processing logs that indicate the status of submitted reports.", Name="Protocols")
protocols: Optional[List[Elma]] = None
"""
Processing logs that indicate the status of submitted reports.
"""
# @ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files")
files: Optional[List[BinaryFile]] = None
"""
Other artefacts including the auxillary files from the BZSt.
"""
# @ApiMember(Description="The status of the response.", Name="ResponseStatus")
response_status: Optional[ResponseStatus] = None
"""
The status of the response.
"""
# @Api(Description="Represents a request to retrieve process protocols for DAC6 in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchRetrieveDac6ProtocolsAsync(BatchRetrieveDac6ProtocolsBase):
"""
Represents a request to retrieve process protocols for DAC6 in an asynchronous operation.
"""
pass
Python BatchRetrieveDac6ProtocolsAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/elma/dac6/protocols/batch/retrieve HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"searchCriteria":[{"name":"String","designation":"CC"}],"credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"stagingEnabled":false}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length
{"protocols":[{"id":"String","schemaLocation":"String","verfahren":"CC","elmaKom":{"elmakomVersion":"String","elmaHeader":{"datenArt":"ELMA_CC","authSteuernummer":"String","accountId":"String","erstellungsDatum":"\/Date(-62135596800000-0000)\/","kundeneigeneId":"String","uuid":"00000000000000000000000000000000","verarbeitungslauf":"PRODUKTIONSLAUF"},"elmaVerfahren":{"inhalt":{}}},"elmaProtokoll":{"dateiname":"String","authSteuernummer":"String","accountId":"String","verarbeitungsDatum":"\/Date(-62135596800000-0000)\/","verarbeitungsZeit":"\/Date(-62135596800000-0000)\/","status":"ELMA_GLOBAL_UNBEKANNT","statusText":"String","statusDetail":"String","kundeneigeneId":"String","uuid":"00000000000000000000000000000000"},"elmaFehler":{"dateiname":"String","authSteuernummer":"String","accountId":"String","verarbeitungsDatum":"\/Date(-62135596800000-0000)\/","verarbeitungsZeit":"\/Date(-62135596800000-0000)\/","fehlerID":"ELMA_GLOBAL_UNBEKANNT","fehlerText":"String","fehlerProzess":"String","kundeneigeneId":"String","uuid":"00000000000000000000000000000000"}}],"files":[{"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=="}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}