Report Filing Service
| POST | /sync/elma/reports/validate |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Represents a request to validate a report.
*/
@Api(Description="Represents a request to validate a report.")
public static class ValidateReport extends ValidateReportBase
{
}
/**
* Specifies a request to validate a report.
*/
@Api(Description="Specifies a request to validate a report.")
public static class ValidateReportBase implements IPost
{
/**
* The report to validate.
*/
@ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")
public Report report = null;
public Report getReport() { return report; }
public ValidateReportBase setReport(Report value) { this.report = value; return this; }
}
/**
* Represents an ELMA report.
*/
@Api(Description="Represents an ELMA report.")
public static class Report
{
/**
* 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 String id = null;
/**
* The XML-content of the report.
*/
@ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
public String data = null;
public String getId() { return id; }
public Report setId(String value) { this.id = value; return this; }
public String getData() { return data; }
public Report setData(String value) { this.data = value; return this; }
}
/**
* Encapsulates the results of validating a report
*/
@Api(Description="Encapsulates the results of validating a report")
public static class ValidationResponse
{
/**
* 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 String id = null;
/**
* The errors encountered during the report validation operation.
*/
@ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")
public ArrayList<ValidationError> validationErrors = null;
/**
* The status of the validation operation.
*/
@ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")
public ResponseStatus responseStatus = null;
public String getId() { return id; }
public ValidationResponse setId(String value) { this.id = value; return this; }
public ArrayList<ValidationError> getValidationErrors() { return validationErrors; }
public ValidationResponse setValidationErrors(ArrayList<ValidationError> value) { this.validationErrors = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public ValidationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* 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 static class ValidationError
{
/**
* 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 String id = null;
/**
* The message of the validation failure.
*/
@ApiMember(Description="The message of the validation failure.", Name="Message")
public String message = null;
/**
* The severity of the validation faílure.
*/
@ApiMember(Description="The severity of the validation faílure.", Name="Severity")
public XmlSeverityType severity = null;
/**
* The line number indicating where the error occurred.
*/
@ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
public Integer lineNumber = null;
/**
* The line position indicating where the error occurred.
*/
@ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
public Integer linePosition = null;
public String getId() { return id; }
public ValidationError setId(String value) { this.id = value; return this; }
public String getMessage() { return message; }
public ValidationError setMessage(String value) { this.message = value; return this; }
public XmlSeverityType getSeverity() { return severity; }
public ValidationError setSeverity(XmlSeverityType value) { this.severity = value; return this; }
public Integer getLineNumber() { return lineNumber; }
public ValidationError setLineNumber(Integer value) { this.lineNumber = value; return this; }
public Integer getLinePosition() { return linePosition; }
public ValidationError setLinePosition(Integer value) { this.linePosition = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
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
}
}
}