Report Filing Service

ValidateReportAsync

ValidateReportAsync

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

The following routes are available for this service:
POST	/async/elma/reports/validate


/** @description Represents an ELMA report. */
// @Api(Description="Represents an ELMA report.")
export class Report
{
    /** @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. */
    // @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 id: string;

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

    public constructor(init?: Partial<Report>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<ValidateReportBase>) { (Object as any).assign(this, init); }
}

/** @description 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. ")
export class ValidationError
{
    /** @description 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 id: string;

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

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

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

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

    public constructor(init?: Partial<ValidationError>) { (Object as any).assign(this, init); }
}

/** @description Encapsulates the results of validating a report */
// @Api(Description="Encapsulates the results of validating a report")
export class ValidationResponse
{
    /** @description 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 id: string;

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

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

    public constructor(init?: Partial<ValidationResponse>) { (Object as any).assign(this, init); }
}

/** @description Represents a request to validate a report in an asynchronous operation. */
// @Api(Description="Represents a request to validate a report in an asynchronous operation.")
export class ValidateReportAsync extends ValidateReportBase
{

    public constructor(init?: Partial<ValidateReportAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ValidateReportAsync DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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.pwc.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}