Report Filing Service

<back to all web services

BrowseFilesAsync

BrowseFilesAsync

Represents a request to browse directories for files on the ELMA server in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
POST/async/elma/files/browse
<?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};


enum DirectoryType : string
{
    case Upload = 'Upload';
    case Download = 'Download';
}

/** @description Represents a PEM-encoded certificate. */
// @Api(Description="Represents a PEM-encoded certificate.")
class PemCertificate implements JsonSerializable
{
    public function __construct(
        /** @description The unique identifier (e.g. the file name) of the certificate. */
        // @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
        /** @var string */
        public string $id='',

        /** @description The PEM-encoded content of the certificate. */
        // @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
        /** @var string */
        public string $content='',

        /** @description The description of the certificate. */
        // @ApiMember(Description="The description of the certificate.", Name="Description")
        /** @var string|null */
        public ?string $description=null,

        /** @description Tags to label or identify the certificate. */
        // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
        /** @var array<string>|null */
        public ?array $tags=null
    ) {
    }

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

/** @description Represents the credentials of a user to authenticate the access of an ELMA server. */
// @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
class ElmaCredential implements IElmaCredential, JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval. */
        // @ApiMember(Description="The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")
        /** @var string */
        public string $id='',

        /** @description The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start) */
        // @ApiMember(Description="The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)", IsRequired=true, Name="Certificate")
        // @Required()
        // @StringLength(2147483647)
        /** @var PemCertificate|null */
        public ?PemCertificate $certificate=null,

        /** @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
        // @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")
        // @Required()
        // @StringLength(11)
        /** @var string */
        public string $authSteuernummer='',

        /** @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
        // @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
        // @Required()
        // @StringLength(10)
        /** @var string */
        public string $accountId='',

        /** @description The password to protect the certificate from unauthorized access. */
        // @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
        /** @var string */
        public string $password=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['certificate'])) $this->certificate = JsonConverters::from('PemCertificate', $o['certificate']);
        if (isset($o['authSteuernummer'])) $this->authSteuernummer = $o['authSteuernummer'];
        if (isset($o['accountId'])) $this->accountId = $o['accountId'];
        if (isset($o['password'])) $this->password = $o['password'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->certificate)) $o['certificate'] = JsonConverters::to('PemCertificate', $this->certificate);
        if (isset($this->authSteuernummer)) $o['authSteuernummer'] = $this->authSteuernummer;
        if (isset($this->accountId)) $o['accountId'] = $this->accountId;
        if (isset($this->password)) $o['password'] = $this->password;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Specifies a request to browse directories for files on the ELMA server. */
// @Api(Description="Specifies a request to browse directories for files on the ELMA server.")
class BrowseFilesBase implements IPost, IAuthenticateRequest, IStageableRequest, JsonSerializable
{
    public function __construct(
        /** @description The directory to browse for files. */
        // @ApiMember(Description="The directory to browse for files.", IsRequired=true)
        /** @var DirectoryType|null */
        public ?DirectoryType $directoryType=null,

        /** @description The credential to gain access on the ELMA server. */
        // @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true)
        /** @var ElmaCredential|null */
        public ?ElmaCredential $credential=null,

        /** @description Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server. */
        // @ApiMember(Description="Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.")
        /** @var bool|null */
        public ?bool $stagingEnabled=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['directoryType'])) $this->directoryType = JsonConverters::from('DirectoryType', $o['directoryType']);
        if (isset($o['credential'])) $this->credential = JsonConverters::from('ElmaCredential', $o['credential']);
        if (isset($o['stagingEnabled'])) $this->stagingEnabled = $o['stagingEnabled'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->directoryType)) $o['directoryType'] = JsonConverters::to('DirectoryType', $this->directoryType);
        if (isset($this->credential)) $o['credential'] = JsonConverters::to('ElmaCredential', $this->credential);
        if (isset($this->stagingEnabled)) $o['stagingEnabled'] = $this->stagingEnabled;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Represents information about a file or directory. */
// @Api(Description="Represents information about a file or directory.")
class FileMetadata implements IFileMetadata, JsonSerializable
{
    public function __construct(
        /** @description The name of the file.For files, gets the name of the file.For directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory. */
        // @ApiMember(Description="The name of the file.\nFor files, gets the name of the file.\nFor directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.")
        /** @var string|null */
        public ?string $name=null,

        /** @description The full path of the directory or file. */
        // @ApiMember(Description="The full path of the directory or file.")
        /** @var string|null */
        public ?string $fullName=null,

        /** @description The time the current file or directory was last accessed. */
        // @ApiMember(Description="The time the current file or directory was last accessed.")
        /** @var DateTime */
        public DateTime $lastAccessTime=new DateTime(),

        /** @description The name of the file. */
        // @ApiMember(Description="The name of the file.")
        /** @var DateTime */
        public DateTime $lastAccessTimeUtc=new DateTime(),

        /** @description The time when the current file or directory was last written to. */
        // @ApiMember(Description="The time when the current file or directory was last written to.")
        /** @var DateTime */
        public DateTime $lastWriteTime=new DateTime(),

        /** @description The time, in coordinated universal time (UTC), when the current file or directory was last written to. */
        // @ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.")
        /** @var DateTime */
        public DateTime $lastWriteTimeUtc=new DateTime(),

        /** @description The size, in bytes, of the current file. */
        // @ApiMember(Description="The size, in bytes, of the current file.")
        /** @var int */
        public int $length=0,

        /** @description The size, in bytes, of the current file. */
        // @ApiMember(Description="The size, in bytes, of the current file.")
        /** @var int */
        public int $userId=0,

        /** @description The file group id. */
        // @ApiMember(Description="The file group id.")
        /** @var int */
        public int $groupId=0,

        /** @description A value that indicates whether the others can read from this file. */
        // @ApiMember(Description="A value that indicates whether the others can read from this file.")
        /** @var bool|null */
        public ?bool $othersCanRead=null,

        /** @description A value that indicates whether the group members can execute this file. */
        // @ApiMember(Description="A value that indicates whether the group members can execute this file.")
        /** @var bool|null */
        public ?bool $groupCanExecute=null,

        /** @description A value that indicates whether the group members can write into this file. */
        // @ApiMember(Description="A value that indicates whether the group members can write into this file.")
        /** @var bool|null */
        public ?bool $groupCanWrite=null,

        /** @description A value that indicates whether the group members can read from this file. */
        // @ApiMember(Description="A value that indicates whether the group members can read from this file.")
        /** @var bool|null */
        public ?bool $groupCanRead=null,

        /** @description A value that indicates whether the owner can execute this file. */
        // @ApiMember(Description="A value that indicates whether the owner can execute this file.")
        /** @var bool|null */
        public ?bool $ownerCanExecute=null,

        /** @description A value that indicates whether the owner can write into this file. */
        // @ApiMember(Description="A value that indicates whether the owner can write into this file.")
        /** @var bool|null */
        public ?bool $ownerCanWrite=null,

        /** @description A value that indicates whether the owner can read from this file. */
        // @ApiMember(Description="A value that indicates whether the owner can read from this file.")
        /** @var bool|null */
        public ?bool $ownerCanRead=null,

        /** @description A value that indicates whether others can read from this file. */
        // @ApiMember(Description="A value that indicates whether others can read from this file.")
        /** @var bool|null */
        public ?bool $othersCanExecute=null,

        /** @description A value that indicates whether others can write into this file. */
        // @ApiMember(Description="A value that indicates whether others can write into this file.")
        /** @var bool|null */
        public ?bool $othersCanWrite=null,

        /** @description Extensions to the file attributes. */
        // @ApiMember(Description="Extensions to the file attributes.")
        /** @var array<string,string>|null */
        public ?array $extensions=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['fullName'])) $this->fullName = $o['fullName'];
        if (isset($o['lastAccessTime'])) $this->lastAccessTime = JsonConverters::from('DateTime', $o['lastAccessTime']);
        if (isset($o['lastAccessTimeUtc'])) $this->lastAccessTimeUtc = JsonConverters::from('DateTime', $o['lastAccessTimeUtc']);
        if (isset($o['lastWriteTime'])) $this->lastWriteTime = JsonConverters::from('DateTime', $o['lastWriteTime']);
        if (isset($o['lastWriteTimeUtc'])) $this->lastWriteTimeUtc = JsonConverters::from('DateTime', $o['lastWriteTimeUtc']);
        if (isset($o['length'])) $this->length = $o['length'];
        if (isset($o['userId'])) $this->userId = $o['userId'];
        if (isset($o['groupId'])) $this->groupId = $o['groupId'];
        if (isset($o['othersCanRead'])) $this->othersCanRead = $o['othersCanRead'];
        if (isset($o['groupCanExecute'])) $this->groupCanExecute = $o['groupCanExecute'];
        if (isset($o['groupCanWrite'])) $this->groupCanWrite = $o['groupCanWrite'];
        if (isset($o['groupCanRead'])) $this->groupCanRead = $o['groupCanRead'];
        if (isset($o['ownerCanExecute'])) $this->ownerCanExecute = $o['ownerCanExecute'];
        if (isset($o['ownerCanWrite'])) $this->ownerCanWrite = $o['ownerCanWrite'];
        if (isset($o['ownerCanRead'])) $this->ownerCanRead = $o['ownerCanRead'];
        if (isset($o['othersCanExecute'])) $this->othersCanExecute = $o['othersCanExecute'];
        if (isset($o['othersCanWrite'])) $this->othersCanWrite = $o['othersCanWrite'];
        if (isset($o['extensions'])) $this->extensions = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['extensions']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->fullName)) $o['fullName'] = $this->fullName;
        if (isset($this->lastAccessTime)) $o['lastAccessTime'] = JsonConverters::to('DateTime', $this->lastAccessTime);
        if (isset($this->lastAccessTimeUtc)) $o['lastAccessTimeUtc'] = JsonConverters::to('DateTime', $this->lastAccessTimeUtc);
        if (isset($this->lastWriteTime)) $o['lastWriteTime'] = JsonConverters::to('DateTime', $this->lastWriteTime);
        if (isset($this->lastWriteTimeUtc)) $o['lastWriteTimeUtc'] = JsonConverters::to('DateTime', $this->lastWriteTimeUtc);
        if (isset($this->length)) $o['length'] = $this->length;
        if (isset($this->userId)) $o['userId'] = $this->userId;
        if (isset($this->groupId)) $o['groupId'] = $this->groupId;
        if (isset($this->othersCanRead)) $o['othersCanRead'] = $this->othersCanRead;
        if (isset($this->groupCanExecute)) $o['groupCanExecute'] = $this->groupCanExecute;
        if (isset($this->groupCanWrite)) $o['groupCanWrite'] = $this->groupCanWrite;
        if (isset($this->groupCanRead)) $o['groupCanRead'] = $this->groupCanRead;
        if (isset($this->ownerCanExecute)) $o['ownerCanExecute'] = $this->ownerCanExecute;
        if (isset($this->ownerCanWrite)) $o['ownerCanWrite'] = $this->ownerCanWrite;
        if (isset($this->ownerCanRead)) $o['ownerCanRead'] = $this->ownerCanRead;
        if (isset($this->othersCanExecute)) $o['othersCanExecute'] = $this->othersCanExecute;
        if (isset($this->othersCanWrite)) $o['othersCanWrite'] = $this->othersCanWrite;
        if (isset($this->extensions)) $o['extensions'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->extensions);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Encapsulates the results of browsing an ELMA server directory */
// @Api(Description="Encapsulates the results of browsing an ELMA server directory")
class BrowseResponse implements JsonSerializable
{
    public function __construct(
        /** @description The files from the file browse operation. */
        // @ApiMember(Description="The files from the file browse operation.", Name="Files")
        /** @var array<FileMetadata>|null */
        public ?array $files=null,

        /** @description The status of the file browse operation. */
        // @ApiMember(Description="The status of the file browse operation.", Name="ResponseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

/** @description Represents a request to browse directories for files on the ELMA server in an asynchronous operation. */
// @Api(Description="Represents a request to browse directories for files on the ELMA server in an asynchronous operation.")
class BrowseFilesAsync extends BrowseFilesBase implements JsonSerializable
{
    /**
     * @param DirectoryType|null $directoryType
     * @param ElmaCredential|null $credential
     * @param bool|null $stagingEnabled
     */
    public function __construct(
        ?DirectoryType $directoryType=null,
        ?ElmaCredential $credential=null,
        ?bool $stagingEnabled=null
    ) {
        parent::__construct($directoryType,$credential,$stagingEnabled);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['directoryType'])) $this->directoryType = JsonConverters::from('DirectoryType', $o['directoryType']);
        if (isset($o['credential'])) $this->credential = JsonConverters::from('ElmaCredential', $o['credential']);
        if (isset($o['stagingEnabled'])) $this->stagingEnabled = $o['stagingEnabled'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->directoryType)) $o['directoryType'] = JsonConverters::to('DirectoryType', $this->directoryType);
        if (isset($this->credential)) $o['credential'] = JsonConverters::to('ElmaCredential', $this->credential);
        if (isset($this->stagingEnabled)) $o['stagingEnabled'] = $this->stagingEnabled;
        return empty($o) ? new class(){} : $o;
    }
}

PHP BrowseFilesAsync DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{
	directoryType: Upload,
	credential: 
	{
		id: String_String,
		certificate: 
		{
			id: String,
			content: String,
			description: String,
			tags: 
			[
				String
			]
		},
		authSteuernummer: String,
		accountId: String,
		password: String
	},
	stagingEnabled: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	files: 
	[
		{
			name: String,
			fullName: String,
			lastAccessTime: 0001-01-01,
			lastAccessTimeUtc: 0001-01-01,
			lastWriteTime: 0001-01-01,
			lastWriteTimeUtc: 0001-01-01,
			length: 0,
			userId: 0,
			groupId: 0,
			othersCanRead: False,
			groupCanExecute: False,
			groupCanWrite: False,
			groupCanRead: False,
			ownerCanExecute: False,
			ownerCanWrite: False,
			ownerCanRead: False,
			othersCanExecute: False,
			othersCanWrite: False,
			extensions: 
			{
				String: String
			}
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}
© 2020 - 2025 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Portions of this program may use third-party open source components governed by the respective open source license terms.