Report Filing Service

<back to all web services

ValidateReportAsync

ValidateReportAsync

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

Requires Authentication
The following routes are available for this service:
POST/async/elma/reports/validate
namespace PwC.Elmaas.Core.Domain.Contracts.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<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. ")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val Id:String = null with get,set

        ///<summary>
        ///The message of the validation failure.
        ///</summary>
        [<ApiMember(Description="The message of the validation failure.", Name="Message")>]
        member val Message:String = null with get,set

        ///<summary>
        ///The severity of the validation faílure.
        ///</summary>
        [<ApiMember(Description="The severity of the validation faílure.", Name="Severity")>]
        member val Severity:XmlSeverityType = new XmlSeverityType() with get,set

        ///<summary>
        ///The line number indicating where the error occurred.
        ///</summary>
        [<ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")>]
        member val LineNumber:Int32 = new Int32() with get,set

        ///<summary>
        ///The line position indicating where the error occurred.
        ///</summary>
        [<ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")>]
        member val LinePosition:Int32 = new Int32() with get,set

    ///<summary>
    ///Encapsulates the results of validating a report
    ///</summary>
    [<Api(Description="Encapsulates the results of validating a report")>]
    [<AllowNullLiteral>]
    type ValidationResponse() = 
        ///<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")>]
        member val Id:String = null with get,set

        ///<summary>
        ///The errors encountered during the report validation operation.
        ///</summary>
        [<ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")>]
        member val ValidationErrors:ResizeArray<ValidationError> = new ResizeArray<ValidationError>() with get,set

        ///<summary>
        ///The status of the validation operation.
        ///</summary>
        [<ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Represents an ELMA report.
    ///</summary>
    [<Api(Description="Represents an ELMA report.")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val Id:String = null with get,set

        ///<summary>
        ///The XML-content of the report.
        ///</summary>
        [<ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")>]
        member val Data:String = null with get,set

    ///<summary>
    ///Specifies a request to validate a report.
    ///</summary>
    [<Api(Description="Specifies a request to validate a report.")>]
    [<AllowNullLiteral>]
    type ValidateReportBase() = 
        interface IPost
        ///<summary>
        ///The report to validate.
        ///</summary>
        [<ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")>]
        member val Report:Report = null with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type ValidateReportAsync() = 
        inherit ValidateReportBase()

F# ValidateReportAsync DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"report":{"id":"String","data":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}