<back to all web services

ValidateReport

Represents a request to validate a report.

import Foundation
import ServiceStack

/**
* Represents a request to validate a report.
*/
// @Api(Description="Represents a request to validate a report.")
public class ValidateReport : ValidateReportBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

/**
* Specifies a request to validate a report.
*/
// @Api(Description="Specifies a request to validate a report.")
public class ValidateReportBase : IPost, Codable
{
    /**
    * The report to validate.
    */
    // @ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")
    public var report:Report

    required public init(){}
}

/**
* Represents an ELMA report.
*/
// @Api(Description="Represents an ELMA report.")
public class Report : Codable
{
    /**
    * 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")
    public var id:String

    /**
    * The XML-content of the report.
    */
    // @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
    public var data:String

    required public init(){}
}

/**
* Encapsulates the results of validating a report
*/
// @Api(Description="Encapsulates the results of validating a report")
public class ValidationResponse : Codable
{
    /**
    * 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")
    public var id:String

    /**
    * The errors encountered during the report validation operation.
    */
    // @ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")
    public var validationErrors:[ValidationError] = []

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

    required public init(){}
}

/**
* 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. ")
public class ValidationError : Codable
{
    /**
    * 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")
    public var id:String

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

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

    /**
    * The line number indicating where the error occurred.
    */
    // @ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
    public var lineNumber:Int

    /**
    * The line position indicating where the error occurred.
    */
    // @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
    public var linePosition:Int

    required public init(){}
}

Swift ValidateReport DTOs

POST /sync/elma/reports/validate HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}