' Options:
'Date: 2024-11-26 01:50:02
'Version: 6.110
'Tip: To override a DTO option, remove "''" prefix before updating
'BaseUrl: https://reportfiling.pwc.de
'
'''GlobalNamespace: 
'''MakePartial: True
'''MakeVirtual: True
'''MakeDataContractsExtensible: False
'''AddReturnMarker: True
'''AddDescriptionAsComments: True
'''AddDataContractAttributes: False
'''AddIndexesToDataMembers: False
'''AddGeneratedCodeAttributes: False
'''AddResponseStatus: False
'''AddImplicitVersion: 
'''InitializeCollections: True
'''ExportValueTypes: False
'IncludeTypes: ValidateReport.*
'''ExcludeTypes: 
'''AddNamespaces: 
'''AddDefaultXmlNamespace: http://schemas.servicestack.net/types

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports System.Xml.Schema
Imports System.Net
Imports PwC.Elmaas.Core.Domain.Contracts.Models
Imports PwC.Elmaas.Core.Services.Contracts.Requests
Imports PwC.Elmaas.Core.Services.Contracts.Responses

Namespace Global

    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 Overridable Property Id As String

            '''<Summary>
            '''The XML-content of the report.
            '''</Summary>
            <ApiMember(Description:="The XML-content of the report.", IsRequired:=true, Name:="Data")>
            Public Overridable Property Data As String
        End Class

        '''<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.
 This is equivalent to the file name of the validated report.", Name:="Id")>
            Public Overridable Property Id As String

            '''<Summary>
            '''The message of the validation failure.
            '''</Summary>
            <ApiMember(Description:="The message of the validation failure.", Name:="Message")>
            Public Overridable Property Message As String

            '''<Summary>
            '''The severity of the validation faílure.
            '''</Summary>
            <ApiMember(Description:="The severity of the validation faílure.", Name:="Severity")>
            Public Overridable Property Severity As XmlSeverityType

            '''<Summary>
            '''The line number indicating where the error occurred.
            '''</Summary>
            <ApiMember(Description:="The line number indicating where the error occurred.", Name:="LineNumber")>
            Public Overridable Property LineNumber As Integer

            '''<Summary>
            '''The line position indicating where the error occurred.
            '''</Summary>
            <ApiMember(Description:="The line position indicating where the error occurred.", Name:="LinePosition")>
            Public Overridable Property LinePosition As Integer
        End Class
    End Namespace

    Namespace PwC.Elmaas.Core.Services.Contracts.Requests

        '''<Summary>
        '''Represents a request to validate a report.
        '''</Summary>
        <Route("/sync/elma/reports/validate", "POST")>
        <Api(Description:="Represents a request to validate a report.")>
        Public Partial Class ValidateReport
            Inherits ValidateReportBase
            Implements IReturn(Of ValidationResponse)
        End Class

        '''<Summary>
        '''Specifies a request to validate a report.
        '''</Summary>
        <Api(Description:="Specifies a request to validate a report.")>
        Public Partial Class ValidateReportBase
            Implements IPost
            '''<Summary>
            '''The report to validate.
            '''</Summary>
            <ApiMember(Description:="The report to validate.", IsRequired:=true, Name:="Report")>
            Public Overridable Property Report As Report
        End Class
    End Namespace

    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 Sub New()
                ValidationErrors = New List(Of ValidationError)
            End Sub

            '''<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.
The identifier is usually the filename.", Name:="Id")>
            Public Overridable Property Id As String

            '''<Summary>
            '''The errors encountered during the report validation operation.
            '''</Summary>
            <ApiMember(Description:="The errors encountered during the report validation operation.", Name:="ValidationErrors")>
            Public Overridable Property ValidationErrors As List(Of ValidationError)

            '''<Summary>
            '''The status of the validation operation.
            '''</Summary>
            <ApiMember(Description:="The status of the validation operation.", Name:="ResponseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace