Report Filing Service
| POST | /sync/elma/protocols/retrieve |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
enum Verfahren
{
CC,
CS,
DC,
FC,
FS,
FA,
KM,
}
/**
* Represent parameters to search or filter on submissions.
*/
// @Api(Description="Represent parameters to search or filter on submissions. ")
class SearchCriteria implements IConvertible
{
/**
* 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")
String? name;
/**
* TThe ELMA product designation.
*/
// @ApiMember(Description="TThe ELMA product designation.", Name="Designation")
Verfahren? designation;
SearchCriteria({this.name,this.designation});
SearchCriteria.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
name = json['name'];
designation = JsonConverters.fromJson(json['designation'],'Verfahren',context!);
return this;
}
Map<String, dynamic> toJson() => {
'name': name,
'designation': JsonConverters.toJson(designation,'Verfahren',context!)
};
getTypeName() => "SearchCriteria";
TypeContext? context = _ctx;
}
/**
* Represents a PEM-encoded certificate.
*/
// @Api(Description="Represents a PEM-encoded certificate.")
class PemCertificate implements IConvertible
{
/**
* 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")
String? id;
/**
* The PEM-encoded content of the certificate.
*/
// @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
String? content;
/**
* The description of the certificate.
*/
// @ApiMember(Description="The description of the certificate.", Name="Description")
String? description;
/**
* Tags to label or identify the certificate.
*/
// @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
List<String>? tags;
PemCertificate({this.id,this.content,this.description,this.tags});
PemCertificate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
content = json['content'];
description = json['description'];
tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'content': content,
'description': description,
'tags': JsonConverters.toJson(tags,'List<String>',context!)
};
getTypeName() => "PemCertificate";
TypeContext? context = _ctx;
}
/**
* 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.")
class ElmaCredential implements IElmaCredential, IConvertible
{
/**
* 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")
String? id;
/**
* 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)
PemCertificate? certificate;
/**
* 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)
String? authSteuernummer;
/**
* 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)
String? accountId;
/**
* The password to protect the certificate from unauthorized access.
*/
// @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
String? password;
ElmaCredential({this.id,this.certificate,this.authSteuernummer,this.accountId,this.password});
ElmaCredential.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
certificate = JsonConverters.fromJson(json['certificate'],'PemCertificate',context!);
authSteuernummer = json['authSteuernummer'];
accountId = json['accountId'];
password = json['password'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'certificate': JsonConverters.toJson(certificate,'PemCertificate',context!),
'authSteuernummer': authSteuernummer,
'accountId': accountId,
'password': password
};
getTypeName() => "ElmaCredential";
TypeContext? context = _ctx;
}
/**
* Specifies a request to retrieve protocols.
*/
// @Api(Description="Specifies a request to retrieve protocols.")
abstract class RetrieveProtocolsBase implements IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest
{
/**
* The parameters to search for protocols.
*/
// @ApiMember(Description="The parameters to search for protocols.", IsRequired=true, Name="SearchCriteria")
SearchCriteria? searchCriteria;
/**
* The credential to gain access on the ELMA server.
*/
// @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
ElmaCredential? credential;
/**
* 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")
bool? stagingEnabled;
RetrieveProtocolsBase({this.searchCriteria,this.credential,this.stagingEnabled});
RetrieveProtocolsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
searchCriteria = JsonConverters.fromJson(json['searchCriteria'],'SearchCriteria',context!);
credential = JsonConverters.fromJson(json['credential'],'ElmaCredential',context!);
stagingEnabled = json['stagingEnabled'];
return this;
}
Map<String, dynamic> toJson() => {
'searchCriteria': JsonConverters.toJson(searchCriteria,'SearchCriteria',context!),
'credential': JsonConverters.toJson(credential,'ElmaCredential',context!),
'stagingEnabled': stagingEnabled
};
getTypeName() => "RetrieveProtocolsBase";
TypeContext? context = _ctx;
}
enum DatenArt
{
ELMA_CC,
ELMA_CCRM,
ELMA_CRS,
ELMA_CRSRM,
ELMA_DC,
ELMA_DCRM,
ELMA_FC,
ELMA_FCRM,
}
enum Verarbeitungslauf
{
PRODUKTIONSLAUF,
TESTLAUF,
}
/**
* Represents the header of an ELMA communication section.
*/
// @Api(Description="Represents the header of an ELMA communication section.")
class ElmaHeader implements IConvertible
{
/**
* 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")
DatenArt? datenArt;
/**
* 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")
String? authSteuernummer;
/**
* 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")
String? accountId;
/**
* 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")
DateTime? erstellungsDatum;
/**
* 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")
String? kundeneigeneId;
/**
* 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")
String? uuid;
/**
* Distinguishes between test and live data transfer.
*/
// @ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf")
Verarbeitungslauf? verarbeitungslauf;
ElmaHeader({this.datenArt,this.authSteuernummer,this.accountId,this.erstellungsDatum,this.kundeneigeneId,this.uuid,this.verarbeitungslauf});
ElmaHeader.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
datenArt = JsonConverters.fromJson(json['datenArt'],'DatenArt',context!);
authSteuernummer = json['authSteuernummer'];
accountId = json['accountId'];
erstellungsDatum = JsonConverters.fromJson(json['erstellungsDatum'],'DateTime',context!);
kundeneigeneId = json['kundeneigeneId'];
uuid = json['uuid'];
verarbeitungslauf = JsonConverters.fromJson(json['verarbeitungslauf'],'Verarbeitungslauf',context!);
return this;
}
Map<String, dynamic> toJson() => {
'datenArt': JsonConverters.toJson(datenArt,'DatenArt',context!),
'authSteuernummer': authSteuernummer,
'accountId': accountId,
'erstellungsDatum': JsonConverters.toJson(erstellungsDatum,'DateTime',context!),
'kundeneigeneId': kundeneigeneId,
'uuid': uuid,
'verarbeitungslauf': JsonConverters.toJson(verarbeitungslauf,'Verarbeitungslauf',context!)
};
getTypeName() => "ElmaHeader";
TypeContext? context = _ctx;
}
class ElmaVerfahren implements IConvertible
{
/**
* The content of process-specific definition.
*/
// @ApiMember(Description="The content of process-specific definition.", Name="Inhalt")
dynamic? inhalt;
ElmaVerfahren({this.inhalt});
ElmaVerfahren.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
inhalt = JsonConverters.fromJson(json['inhalt'],'dynamic',context!);
return this;
}
Map<String, dynamic> toJson() => {
'inhalt': JsonConverters.toJson(inhalt,'dynamic',context!)
};
getTypeName() => "ElmaVerfahren";
TypeContext? context = _ctx;
}
/**
* Represents the communication section of an ELMA report document.
*/
// @Api(Description="Represents the communication section of an ELMA report document.")
class ElmaKom implements IConvertible
{
/**
* The version number of the ELMAKOM definition.
*/
// @ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion")
String? elmakomVersion;
/**
* The header part of the ELMAKOM definition.
*/
// @ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader")
ElmaHeader? elmaHeader;
/**
* The process part of the ELMAKOM definition.
*/
// @ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren")
ElmaVerfahren? elmaVerfahren;
ElmaKom({this.elmakomVersion,this.elmaHeader,this.elmaVerfahren});
ElmaKom.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
elmakomVersion = json['elmakomVersion'];
elmaHeader = JsonConverters.fromJson(json['elmaHeader'],'ElmaHeader',context!);
elmaVerfahren = JsonConverters.fromJson(json['elmaVerfahren'],'ElmaVerfahren',context!);
return this;
}
Map<String, dynamic> toJson() => {
'elmakomVersion': elmakomVersion,
'elmaHeader': JsonConverters.toJson(elmaHeader,'ElmaHeader',context!),
'elmaVerfahren': JsonConverters.toJson(elmaVerfahren,'ElmaVerfahren',context!)
};
getTypeName() => "ElmaKom";
TypeContext? context = _ctx;
}
enum Status
{
ELMA_GLOBAL_UNBEKANNT,
ELMA_OK,
ELMA_PARSER_FEHLER,
ELMA_UNGUELTIGE_KODIERUNG,
ELMA_UNGUELTIGE_DATEINAME,
ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID,
ELMA_SIGNATUR_DATEI_FEHLT,
ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT,
ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN,
ELMA_FREISCHALTUNG_FEHLT,
ELMA_SPERRE_VORHANDEN,
ELMA_DATEINAME_BEREITS_VERWENDET,
ELMA_DATEIINHALT_IDENTISCH,
ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN,
ELMA_TESTDATEN,
}
/**
* 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.")
class ElmaProtokoll implements IConvertible
{
/**
* File name of the processed input ELMA report.
*/
// @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
String? dateiname;
/**
* 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")
String? authSteuernummer;
/**
* 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")
String? accountId;
/**
* 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")
DateTime? verarbeitungsDatum;
/**
* Time of processing by ELAN (ELMA receiving server at BZSt).
*/
// @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")
DateTime? verarbeitungsZeit;
/**
* The status code of the ELMA process.
*/
// @ApiMember(Description="The status code of the ELMA process.", Name="Status")
Status? status;
/**
* A brief description of the status.
*/
// @ApiMember(Description="A brief description of the status.", Name="StatusText")
String? statusText;
/**
* A detailed information on the status.
*/
// @ApiMember(Description="A detailed information on the status.", Name="StatusDetail")
String? statusDetail;
/**
* 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")
String? kundeneigeneId;
/**
* 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")
String? uuid;
ElmaProtokoll({this.dateiname,this.authSteuernummer,this.accountId,this.verarbeitungsDatum,this.verarbeitungsZeit,this.status,this.statusText,this.statusDetail,this.kundeneigeneId,this.uuid});
ElmaProtokoll.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
dateiname = json['dateiname'];
authSteuernummer = json['authSteuernummer'];
accountId = json['accountId'];
verarbeitungsDatum = JsonConverters.fromJson(json['verarbeitungsDatum'],'DateTime',context!);
verarbeitungsZeit = JsonConverters.fromJson(json['verarbeitungsZeit'],'DateTime',context!);
status = JsonConverters.fromJson(json['status'],'Status',context!);
statusText = json['statusText'];
statusDetail = json['statusDetail'];
kundeneigeneId = json['kundeneigeneId'];
uuid = json['uuid'];
return this;
}
Map<String, dynamic> toJson() => {
'dateiname': dateiname,
'authSteuernummer': authSteuernummer,
'accountId': accountId,
'verarbeitungsDatum': JsonConverters.toJson(verarbeitungsDatum,'DateTime',context!),
'verarbeitungsZeit': JsonConverters.toJson(verarbeitungsZeit,'DateTime',context!),
'status': JsonConverters.toJson(status,'Status',context!),
'statusText': statusText,
'statusDetail': statusDetail,
'kundeneigeneId': kundeneigeneId,
'uuid': uuid
};
getTypeName() => "ElmaProtokoll";
TypeContext? context = _ctx;
}
/**
* 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.")
class ElmaFehler implements IConvertible
{
/**
* File name of the processed input ELMA report.
*/
// @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
String? dateiname;
/**
* 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")
String? authSteuernummer;
/**
* 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")
String? accountId;
/**
* 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")
DateTime? verarbeitungsDatum;
/**
* Time of processing by ELAN (ELMA receiving server at BZSt).
*/
// @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")
DateTime? verarbeitungsZeit;
/**
* The status code of the ELMA process.
*/
// @ApiMember(Description="The status code of the ELMA process.", Name="FehlerID")
Status? fehlerID;
/**
* A brief description of the error status.
*/
// @ApiMember(Description="A brief description of the error status.", Name="FehlerText")
String? fehlerText;
/**
* A detailed information on the status.
*/
// @ApiMember(Description="A detailed information on the status.", Name="FehlerProzess")
String? fehlerProzess;
/**
* 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")
String? kundeneigeneId;
/**
* 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")
String? uuid;
ElmaFehler({this.dateiname,this.authSteuernummer,this.accountId,this.verarbeitungsDatum,this.verarbeitungsZeit,this.fehlerID,this.fehlerText,this.fehlerProzess,this.kundeneigeneId,this.uuid});
ElmaFehler.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
dateiname = json['dateiname'];
authSteuernummer = json['authSteuernummer'];
accountId = json['accountId'];
verarbeitungsDatum = JsonConverters.fromJson(json['verarbeitungsDatum'],'DateTime',context!);
verarbeitungsZeit = JsonConverters.fromJson(json['verarbeitungsZeit'],'DateTime',context!);
fehlerID = JsonConverters.fromJson(json['fehlerID'],'Status',context!);
fehlerText = json['fehlerText'];
fehlerProzess = json['fehlerProzess'];
kundeneigeneId = json['kundeneigeneId'];
uuid = json['uuid'];
return this;
}
Map<String, dynamic> toJson() => {
'dateiname': dateiname,
'authSteuernummer': authSteuernummer,
'accountId': accountId,
'verarbeitungsDatum': JsonConverters.toJson(verarbeitungsDatum,'DateTime',context!),
'verarbeitungsZeit': JsonConverters.toJson(verarbeitungsZeit,'DateTime',context!),
'fehlerID': JsonConverters.toJson(fehlerID,'Status',context!),
'fehlerText': fehlerText,
'fehlerProzess': fehlerProzess,
'kundeneigeneId': kundeneigeneId,
'uuid': uuid
};
getTypeName() => "ElmaFehler";
TypeContext? context = _ctx;
}
/**
* Represents an ELMA report document.
*/
// @Api(Description="Represents an ELMA report document.")
class Elma implements IConvertible
{
/**
* 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")
String? id;
/**
* 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")
String? schemaLocation;
/**
* The type of reporting process.
*/
// @ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren")
Verfahren? verfahren;
/**
* The communication section of the ELMA report document.
*/
// @ApiMember(Description="The communication section of the ELMA report document.", IsRequired=true, Name="ElmaKom")
ElmaKom? elmaKom;
/**
* The communication section of the ELMA report document.
*/
// @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll")
ElmaProtokoll? elmaProtokoll;
/**
* The communication section of the ELMA report document.
*/
// @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler")
ElmaFehler? elmaFehler;
Elma({this.id,this.schemaLocation,this.verfahren,this.elmaKom,this.elmaProtokoll,this.elmaFehler});
Elma.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
schemaLocation = json['schemaLocation'];
verfahren = JsonConverters.fromJson(json['verfahren'],'Verfahren',context!);
elmaKom = JsonConverters.fromJson(json['elmaKom'],'ElmaKom',context!);
elmaProtokoll = JsonConverters.fromJson(json['elmaProtokoll'],'ElmaProtokoll',context!);
elmaFehler = JsonConverters.fromJson(json['elmaFehler'],'ElmaFehler',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'schemaLocation': schemaLocation,
'verfahren': JsonConverters.toJson(verfahren,'Verfahren',context!),
'elmaKom': JsonConverters.toJson(elmaKom,'ElmaKom',context!),
'elmaProtokoll': JsonConverters.toJson(elmaProtokoll,'ElmaProtokoll',context!),
'elmaFehler': JsonConverters.toJson(elmaFehler,'ElmaFehler',context!)
};
getTypeName() => "Elma";
TypeContext? context = _ctx;
}
/**
* Represents a base class for a file with raw data.
*/
// @Api(Description="Represents a base class for a file with raw data.")
abstract class FileBase
{
/**
* The raw data content of the file.
*/
// @ApiMember(Description="The raw data content of the file.", Name="Content")
Uint8List? content;
FileBase({this.content});
FileBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
content = JsonConverters.fromJson(json['content'],'Uint8List',context!);
return this;
}
Map<String, dynamic> toJson() => {
'content': JsonConverters.toJson(content,'Uint8List',context!)
};
getTypeName() => "FileBase";
TypeContext? context = _ctx;
}
/**
* Represents information about a file or directory.
*/
// @Api(Description="Represents information about a file or directory.")
class FileMetadata implements IFileMetadata, IConvertible
{
/**
* 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")
String? name;
/**
* The full path of the directory or file.
*/
// @ApiMember(Description="The full path of the directory or file.", Name="FullName")
String? fullName;
/**
* The time the current file or directory was last accessed.
*/
// @ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")
DateTime? lastAccessTime;
/**
* The name of the file.
*/
// @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
DateTime? lastAccessTimeUtc;
/**
* 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")
DateTime? lastWriteTime;
/**
* 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")
DateTime? lastWriteTimeUtc;
/**
* The size, in bytes, of the current file.
*/
// @ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
int? length;
/**
* The size, in bytes, of the current file.
*/
// @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
int? userId;
/**
* The file group id.
*/
// @ApiMember(Description="The file group id.", Name="GroupId")
int? groupId;
/**
* 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")
bool? othersCanRead;
/**
* 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")
bool? groupCanExecute;
/**
* 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")
bool? groupCanWrite;
/**
* 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")
bool? groupCanRead;
/**
* 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")
bool? ownerCanExecute;
/**
* 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")
bool? ownerCanWrite;
/**
* 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")
bool? ownerCanRead;
/**
* 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")
bool? othersCanExecute;
/**
* 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")
bool? othersCanWrite;
/**
* Extensions to the file attributes.
*/
// @ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
Map<String,String?>? extensions;
FileMetadata({this.name,this.fullName,this.lastAccessTime,this.lastAccessTimeUtc,this.lastWriteTime,this.lastWriteTimeUtc,this.length,this.userId,this.groupId,this.othersCanRead,this.groupCanExecute,this.groupCanWrite,this.groupCanRead,this.ownerCanExecute,this.ownerCanWrite,this.ownerCanRead,this.othersCanExecute,this.othersCanWrite,this.extensions});
FileMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
name = json['name'];
fullName = json['fullName'];
lastAccessTime = JsonConverters.fromJson(json['lastAccessTime'],'DateTime',context!);
lastAccessTimeUtc = JsonConverters.fromJson(json['lastAccessTimeUtc'],'DateTime',context!);
lastWriteTime = JsonConverters.fromJson(json['lastWriteTime'],'DateTime',context!);
lastWriteTimeUtc = JsonConverters.fromJson(json['lastWriteTimeUtc'],'DateTime',context!);
length = json['length'];
userId = json['userId'];
groupId = json['groupId'];
othersCanRead = json['othersCanRead'];
groupCanExecute = json['groupCanExecute'];
groupCanWrite = json['groupCanWrite'];
groupCanRead = json['groupCanRead'];
ownerCanExecute = json['ownerCanExecute'];
ownerCanWrite = json['ownerCanWrite'];
ownerCanRead = json['ownerCanRead'];
othersCanExecute = json['othersCanExecute'];
othersCanWrite = json['othersCanWrite'];
extensions = JsonConverters.toStringMap(json['extensions']);
return this;
}
Map<String, dynamic> toJson() => {
'name': name,
'fullName': fullName,
'lastAccessTime': JsonConverters.toJson(lastAccessTime,'DateTime',context!),
'lastAccessTimeUtc': JsonConverters.toJson(lastAccessTimeUtc,'DateTime',context!),
'lastWriteTime': JsonConverters.toJson(lastWriteTime,'DateTime',context!),
'lastWriteTimeUtc': JsonConverters.toJson(lastWriteTimeUtc,'DateTime',context!),
'length': length,
'userId': userId,
'groupId': groupId,
'othersCanRead': othersCanRead,
'groupCanExecute': groupCanExecute,
'groupCanWrite': groupCanWrite,
'groupCanRead': groupCanRead,
'ownerCanExecute': ownerCanExecute,
'ownerCanWrite': ownerCanWrite,
'ownerCanRead': ownerCanRead,
'othersCanExecute': othersCanExecute,
'othersCanWrite': othersCanWrite,
'extensions': extensions
};
getTypeName() => "FileMetadata";
TypeContext? context = _ctx;
}
/**
* Represents a file that contains raw data content in bytes
*/
// @Api(Description="Represents a file that contains raw data content in bytes")
class BinaryFile extends FileBase implements IConvertible
{
/**
* The attributes of the file.
*/
// @ApiMember(Description="The attributes of the file.", Name="Metadata")
FileMetadata? metadata;
/**
* 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")
String? name;
BinaryFile({this.metadata,this.name});
BinaryFile.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
metadata = JsonConverters.fromJson(json['metadata'],'FileMetadata',context!);
name = json['name'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'metadata': JsonConverters.toJson(metadata,'FileMetadata',context!),
'name': name
});
getTypeName() => "BinaryFile";
TypeContext? context = _ctx;
}
/**
* Encapsulates the results of a protocol retrieval operation.
*/
// @Api(Description="Encapsulates the results of a protocol retrieval operation.")
class RetrievalResponse implements IConvertible
{
/**
* Processing logs that indicate the status of submitted reports.
*/
// @ApiMember(Description="Processing logs that indicate the status of submitted reports.", Name="Protocols")
List<Elma>? protocols;
/**
* Other artefacts including the auxillary files from the BZSt.
*/
// @ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files")
List<BinaryFile>? files;
/**
* The status of the response.
*/
// @ApiMember(Description="The status of the response.", Name="ResponseStatus")
ResponseStatus? responseStatus;
RetrievalResponse({this.protocols,this.files,this.responseStatus});
RetrievalResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
protocols = JsonConverters.fromJson(json['protocols'],'List<Elma>',context!);
files = JsonConverters.fromJson(json['files'],'List<BinaryFile>',context!);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'protocols': JsonConverters.toJson(protocols,'List<Elma>',context!),
'files': JsonConverters.toJson(files,'List<BinaryFile>',context!),
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "RetrievalResponse";
TypeContext? context = _ctx;
}
/**
* Represents a request to retrieve protocols.
*/
// @Api(Description="Represents a request to retrieve protocols.")
class RetrieveProtocols extends RetrieveProtocolsBase implements IConvertible
{
RetrieveProtocols();
RetrieveProtocols.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "RetrieveProtocols";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
'Verfahren': TypeInfo(TypeOf.Enum, enumValues:Verfahren.values),
'SearchCriteria': TypeInfo(TypeOf.Class, create:() => SearchCriteria()),
'PemCertificate': TypeInfo(TypeOf.Class, create:() => PemCertificate()),
'ElmaCredential': TypeInfo(TypeOf.Class, create:() => ElmaCredential()),
'RetrieveProtocolsBase': TypeInfo(TypeOf.AbstractClass),
'DatenArt': TypeInfo(TypeOf.Enum, enumValues:DatenArt.values),
'Verarbeitungslauf': TypeInfo(TypeOf.Enum, enumValues:Verarbeitungslauf.values),
'ElmaHeader': TypeInfo(TypeOf.Class, create:() => ElmaHeader()),
'ElmaVerfahren': TypeInfo(TypeOf.Class, create:() => ElmaVerfahren()),
'ElmaKom': TypeInfo(TypeOf.Class, create:() => ElmaKom()),
'Status': TypeInfo(TypeOf.Enum, enumValues:Status.values),
'ElmaProtokoll': TypeInfo(TypeOf.Class, create:() => ElmaProtokoll()),
'ElmaFehler': TypeInfo(TypeOf.Class, create:() => ElmaFehler()),
'Elma': TypeInfo(TypeOf.Class, create:() => Elma()),
'FileBase': TypeInfo(TypeOf.AbstractClass),
'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
'FileMetadata': TypeInfo(TypeOf.Class, create:() => FileMetadata()),
'BinaryFile': TypeInfo(TypeOf.Class, create:() => BinaryFile()),
'RetrievalResponse': TypeInfo(TypeOf.Class, create:() => RetrievalResponse()),
'List<Elma>': TypeInfo(TypeOf.Class, create:() => <Elma>[]),
'List<BinaryFile>': TypeInfo(TypeOf.Class, create:() => <BinaryFile>[]),
'RetrieveProtocols': TypeInfo(TypeOf.Class, create:() => RetrieveProtocols()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/elma/protocols/retrieve HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length
{
protocols:
[
{
id: String,
schemaLocation: String,
verfahren: CC,
elmaKom:
{
elmakomVersion: String,
elmaHeader:
{
datenArt: ELMA_CC,
authSteuernummer: String,
accountId: String,
erstellungsDatum: 0001-01-01,
kundeneigeneId: String,
uuid: 00000000000000000000000000000000,
verarbeitungslauf: PRODUKTIONSLAUF
},
elmaVerfahren:
{
inhalt: {}
}
},
elmaProtokoll:
{
dateiname: String,
authSteuernummer: String,
accountId: String,
verarbeitungsDatum: 0001-01-01,
verarbeitungsZeit: 0001-01-01,
status: ELMA_GLOBAL_UNBEKANNT,
statusText: String,
statusDetail: String,
kundeneigeneId: String,
uuid: 00000000000000000000000000000000
},
elmaFehler:
{
dateiname: String,
authSteuernummer: String,
accountId: String,
verarbeitungsDatum: 0001-01-01,
verarbeitungsZeit: 0001-01-01,
fehlerID: ELMA_GLOBAL_UNBEKANNT,
fehlerText: String,
fehlerProzess: String,
kundeneigeneId: String,
uuid: 00000000000000000000000000000000
}
}
],
files:
[
{
metadata:
{
name: String,
fullName: String,
lastAccessTime: 0001-01-01,
lastAccessTimeUtc: 0001-01-01,
lastWriteTime: 0001-01-01,
lastWriteTimeUtc: 0001-01-01,
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
}
}
}