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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Elmaas.Core.Services.Contracts.Requests;
using PwC.Elmaas.Core.Domain.Contracts.Models;
using PwC.Elmaas.Core.Services.Contracts.Responses;

namespace PwC.Elmaas.Core.Domain.Contracts.Models
{
    ///<summary>
    ///Represents an ELMA report.
    ///</summary>
    [Api(Description="Represents an ELMA report.")]
    public partial class Report
    {
        ///<summary>
        ///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.
        ///</summary>
        [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")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The XML-content of the report.
        ///</summary>
        [ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")]
        public virtual string Data { get; set; }
    }

    ///<summary>
    ///Represents a  failure encountered during the validation of an ELMA report against its XML schema. 
    ///</summary>
    [Api(Description="Represents a  failure encountered during the validation of an ELMA report against its XML schema. ")]
    public partial class ValidationError
    {
        ///<summary>
        ///The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
        ///</summary>
        [ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The message of the validation failure.
        ///</summary>
        [ApiMember(Description="The message of the validation failure.", Name="Message")]
        public virtual string Message { get; set; }

        ///<summary>
        ///The severity of the validation faílure.
        ///</summary>
        [ApiMember(Description="The severity of the validation faílure.", Name="Severity")]
        public virtual XmlSeverityType Severity { get; set; }

        ///<summary>
        ///The line number indicating where the error occurred.
        ///</summary>
        [ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")]
        public virtual int LineNumber { get; set; }

        ///<summary>
        ///The line position indicating where the error occurred.
        ///</summary>
        [ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")]
        public virtual int LinePosition { get; set; }
    }

}

namespace PwC.Elmaas.Core.Services.Contracts.Requests
{
    ///<summary>
    ///Represents a request to validate a report in an asynchronous operation.
    ///</summary>
    [Api(Description="Represents a request to validate a report in an asynchronous operation.")]
    public partial class ValidateReportAsync
        : ValidateReportBase
    {
    }

    ///<summary>
    ///Specifies a request to validate a report.
    ///</summary>
    [Api(Description="Specifies a request to validate a report.")]
    public partial class ValidateReportBase
        : IPost
    {
        ///<summary>
        ///The report to validate.
        ///</summary>
        [ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")]
        public virtual Report Report { get; set; }
    }

}

namespace PwC.Elmaas.Core.Services.Contracts.Responses
{
    ///<summary>
    ///Encapsulates the results of validating a report
    ///</summary>
    [Api(Description="Encapsulates the results of validating a report")]
    public partial class ValidationResponse
    {
        public ValidationResponse()
        {
            ValidationErrors = new List<ValidationError>{};
        }

        ///<summary>
        ///The unique identifier of the report that was processed.The identifier is usually the filename.
        ///</summary>
        [ApiMember(Description="The unique identifier of the report that was processed.\nThe identifier is usually the filename.", Name="Id")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The errors encountered during the report validation operation.
        ///</summary>
        [ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")]
        public virtual List<ValidationError> ValidationErrors { get; set; }

        ///<summary>
        ///The status of the validation operation.
        ///</summary>
        [ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# ValidateReportAsync DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"report":{"id":"String","data":"String"}}

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

{"id":"String","validationErrors":[{"id":"String","message":"String","severity":"Error","lineNumber":0,"linePosition":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}