<back to all web services

BatchValidateReports

Represents a request to validate reports in a batch operation.

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Represents an ELMA report.
*/
// @Api(Description="Represents an ELMA report.")
class Report implements IConvertible
{
    /**
    * The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.
    */
    // @ApiMember(Description="The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.", IsRequired=true, Name="Id")
    String? id;

    /**
    * The XML-content of the report.
    */
    // @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
    String? data;

    Report({this.id,this.data});
    Report.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        data = json['data'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'data': data
    };

    getTypeName() => "Report";
    TypeContext? context = _ctx;
}

/**
* Specifies a request to validate reports in a batch operation.
*/
// @Api(Description="Specifies a request to validate reports in a batch operation.")
abstract class BatchValidateReportsBase implements IPost
{
    /**
    * The reports to validate.
    */
    // @ApiMember(Description="The reports to validate.", IsRequired=true, Name="Reports")
    List<Report>? reports;

    BatchValidateReportsBase({this.reports});
    BatchValidateReportsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        reports = JsonConverters.fromJson(json['reports'],'List<Report>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'reports': JsonConverters.toJson(reports,'List<Report>',context!)
    };

    getTypeName() => "BatchValidateReportsBase";
    TypeContext? context = _ctx;
}

/**
* Represents a request to validate reports in a batch operation.
*/
// @Api(Description="Represents a request to validate reports in a batch operation.")
class BatchValidateReports extends BatchValidateReportsBase implements IConvertible
{
    BatchValidateReports();
    BatchValidateReports.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() => "BatchValidateReports";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'reportfiling.pwc.de', types: <String, TypeInfo> {
    'Report': TypeInfo(TypeOf.Class, create:() => Report()),
    'BatchValidateReportsBase': TypeInfo(TypeOf.AbstractClass),
    'List<Report>': TypeInfo(TypeOf.Class, create:() => <Report>[]),
    'BatchValidateReports': TypeInfo(TypeOf.Class, create:() => BatchValidateReports()),
});

Dart BatchValidateReports DTOs

POST /sync/elma/reports/batch/validate HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchValidateReports xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Requests">
  <Reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
    <d2p1:Report>
      <d2p1:Data>String</d2p1:Data>
      <d2p1:Id>String</d2p1:Id>
    </d2p1:Report>
  </Reports>
</BatchValidateReports>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
  <ValidationResponse>
    <Id>String</Id>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <ValidationErrors xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
      <d3p1:ValidationError>
        <d3p1:Id>String</d3p1:Id>
        <d3p1:LineNumber>0</d3p1:LineNumber>
        <d3p1:LinePosition>0</d3p1:LinePosition>
        <d3p1:Message>String</d3p1:Message>
        <d3p1:Severity>Error</d3p1:Severity>
      </d3p1:ValidationError>
    </ValidationErrors>
  </ValidationResponse>
</ArrayOfValidationResponse>