Report Filing Service

RetrieveDac6Files

RetrieveDAC6FilesSync

Represents a request to retrieve DAC6 protocol files from the ELMA server in a zip file.

The following routes are available for this service:
POST	/sync/elma/dac6/files/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 to retrieve DAC6 protocol files from the ELMA server in a zip file.
*/
// @Api(Description="Specifies a request to to retrieve DAC6 protocol files from the ELMA server in a zip file.")
abstract class RetrieveDac6FilesBase implements IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest
{
    /**
    * The parameters to search or filter on the protocols.
    */
    // @ApiMember(Description="The parameters to search or filter on the 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;

    RetrieveDac6FilesBase({this.searchCriteria,this.credential,this.stagingEnabled});
    RetrieveDac6FilesBase.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() => "RetrieveDac6FilesBase";
    TypeContext? context = _ctx;
}

/**
* Represents a request to retrieve DAC6 protocol files from the ELMA server in a zip file.
*/
// @Api(Description="Represents a request to retrieve DAC6 protocol files from the ELMA server in a zip file.")
class RetrieveDac6Files extends RetrieveDac6FilesBase implements IConvertible
{
    RetrieveDac6Files();
    RetrieveDac6Files.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() => "RetrieveDac6Files";
    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()),
    'RetrieveDac6FilesBase': TypeInfo(TypeOf.AbstractClass),
    'RetrieveDac6Files': TypeInfo(TypeOf.Class, create:() => RetrieveDac6Files()),
});

Dart RetrieveDac6Files DTOs

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

HTTP + X-MSGPACK

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

POST /sync/elma/dac6/files/retrieve HTTP/1.1 
Host: reportfiling.staging.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}