Report Filing Service

ValidateReportAsync

ValidateReportAsync

Represents a request to validate a report in an asynchronous operation.

The following routes are available for this service:
POST	/async/elma/reports/validate

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 a report.
*/
// @Api(Description="Specifies a request to validate a report.")
abstract class ValidateReportBase implements IPost
{
    /**
    * The report to validate.
    */
    // @ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")
    Report? report;

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

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

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

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

/**
* Represents a  failure encountered during the validation of an ELMA report against its XML schema. 
*/
// @Api(Description="Represents a  failure encountered during the validation of an ELMA report against its XML schema. ")
class ValidationError implements IConvertible
{
    /**
    * The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
    */
    // @ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")
    String? id;

    /**
    * The message of the validation failure.
    */
    // @ApiMember(Description="The message of the validation failure.", Name="Message")
    String? message;

    /**
    * The severity of the validation faílure.
    */
    // @ApiMember(Description="The severity of the validation faílure.", Name="Severity")
    XmlSeverityType? severity;

    /**
    * The line number indicating where the error occurred.
    */
    // @ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
    int? lineNumber;

    /**
    * The line position indicating where the error occurred.
    */
    // @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
    int? linePosition;

    ValidationError({this.id,this.message,this.severity,this.lineNumber,this.linePosition});
    ValidationError.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        message = json['message'];
        severity = JsonConverters.fromJson(json['severity'],'XmlSeverityType',context!);
        lineNumber = json['lineNumber'];
        linePosition = json['linePosition'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'message': message,
        'severity': JsonConverters.toJson(severity,'XmlSeverityType',context!),
        'lineNumber': lineNumber,
        'linePosition': linePosition
    };

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

/**
* Encapsulates the results of validating a report
*/
// @Api(Description="Encapsulates the results of validating a report")
class ValidationResponse implements IConvertible
{
    /**
    * The unique identifier of the report that was processed.The identifier is usually the filename.
    */
    // @ApiMember(Description="The unique identifier of the report that was processed.\nThe identifier is usually the filename.", Name="Id")
    String? id;

    /**
    * The errors encountered during the report validation operation.
    */
    // @ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")
    List<ValidationError>? validationErrors;

    /**
    * The status of the validation operation.
    */
    // @ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")
    ResponseStatus? responseStatus;

    ValidationResponse({this.id,this.validationErrors,this.responseStatus});
    ValidationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        validationErrors = JsonConverters.fromJson(json['validationErrors'],'List<ValidationError>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'validationErrors': JsonConverters.toJson(validationErrors,'List<ValidationError>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

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

TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
    'Report': TypeInfo(TypeOf.Class, create:() => Report()),
    'ValidateReportBase': TypeInfo(TypeOf.AbstractClass),
    'ValidationError': TypeInfo(TypeOf.Class, create:() => ValidationError()),
    'XmlSeverityType': TypeInfo(TypeOf.Class, create:() => XmlSeverityType()),
    'ValidationResponse': TypeInfo(TypeOf.Class, create:() => ValidationResponse()),
    'List<ValidationError>': TypeInfo(TypeOf.Class, create:() => <ValidationError>[]),
    'ValidateReportAsync': TypeInfo(TypeOf.Class, create:() => ValidateReportAsync()),
});

Dart ValidateReportAsync DTOs

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

HTTP + XML

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

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

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

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

<ValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
  <Id>String</Id>
  <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>
  <ValidationErrors xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
    <d2p1:ValidationError>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:LineNumber>0</d2p1:LineNumber>
      <d2p1:LinePosition>0</d2p1:LinePosition>
      <d2p1:Message>String</d2p1:Message>
      <d2p1:Severity>Error</d2p1:Severity>
    </d2p1:ValidationError>
  </ValidationErrors>
</ValidationResponse>