/* Options:
Date: 2024-11-26 01:58:12
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.pwc.de

//GlobalNamespace: 
//MakePartial: True
//MakeVirtual: True
//MakeInternal: False
//MakeDataContractsExtensible: False
//AddNullableAnnotations: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//InitializeCollections: True
//ExportValueTypes: False
IncludeTypes: BatchValidateReportsAsync.*
//ExcludeTypes: 
//AddNamespaces: 
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using System.Xml.Schema;
using System.Net;
using PwC.Elmaas.Core.Domain.Contracts.Models;
using PwC.Elmaas.Core.Services.Contracts.Requests;
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_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.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_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.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 reports in an asynchronous batch operation.
    ///</summary>
    [Route("/async/elma/reports/batch/validate", "POST")]
    [Api(Description="Represents a request to validate reports in an asynchronous batch operation.")]
    public partial class BatchValidateReportsAsync
        : BatchValidateReportsBase, IReturn<List<ValidationResponse>>
    {
    }

    ///<summary>
    ///Specifies a request to validate reports in a batch operation.
    ///</summary>
    [Api(Description="Specifies a request to validate reports in a batch operation.")]
    public partial class BatchValidateReportsBase
        : IPost
    {
        public BatchValidateReportsBase()
        {
            Reports = new List<Report>{};
        }

        ///<summary>
        ///The reports to validate.
        ///</summary>
        [ApiMember(Description="The reports to validate.", IsRequired=true, Name="Reports")]
        public virtual List<Report> Reports { 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; }
    }

}