<back to all web services

BatchValidateReportsAsync

Represents a request to validate reports in an asynchronous batch operation.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Represents an ELMA report. */
// @Api(Description="Represents an ELMA report.")
class Report implements JsonSerializable
{
    public function __construct(
        /** @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")
        /** @var string */
        public string $id='',

        /** @description The XML-content of the report. */
        // @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
        /** @var string */
        public string $data=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['data'])) $this->data = $o['data'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->data)) $o['data'] = $this->data;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Specifies a request to validate reports in a batch operation. */
// @Api(Description="Specifies a request to validate reports in a batch operation.")
class BatchValidateReportsBase implements IPost, JsonSerializable
{
    public function __construct(
        /** @description The reports to validate. */
        // @ApiMember(Description="The reports to validate.", IsRequired=true)
        /** @var array<Report>|null */
        public ?array $reports=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['reports'])) $this->reports = JsonConverters::fromArray('Report', $o['reports']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->reports)) $o['reports'] = JsonConverters::toArray('Report', $this->reports);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Represents a request to validate reports in an asynchronous batch operation. */
// @Api(Description="Represents a request to validate reports in an asynchronous batch operation.")
class BatchValidateReportsAsync extends BatchValidateReportsBase implements JsonSerializable
{
    /**
     * @param array<Report>|null $reports
     */
    public function __construct(
        ?array $reports=null
    ) {
        parent::__construct($reports);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['reports'])) $this->reports = JsonConverters::fromArray('Report', $o['reports']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->reports)) $o['reports'] = JsonConverters::toArray('Report', $this->reports);
        return empty($o) ? new class(){} : $o;
    }
}

PHP BatchValidateReportsAsync DTOs

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

{
	reports: 
	[
		{
			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
			}
		}
	}
]