Report Filing Service

<back to all web services

BrowseFiles

BrowseFilesSync

Represents a request to browse directories for files on the ELMA server.

Requires Authentication
The following routes are available for this service:
POST/sync/elma/files/browse

export enum DirectoryType
{
    Upload = 'Upload',
    Download = 'Download',
}

/** @description Represents a PEM-encoded certificate. */
// @Api(Description="Represents a PEM-encoded certificate.")
export class PemCertificate
{
    /** @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")
    public id: string;

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

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

    /** @description Tags to label or identify the certificate. */
    // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    public tags: string[];

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

/** @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.")
export class ElmaCredential implements IElmaCredential
{
    /** @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")
    public id: string;

    /** @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)
    public certificate: PemCertificate;

    /** @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)
    public authSteuernummer: string;

    /** @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)
    public accountId: string;

    /** @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")
    public password: string;

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

/** @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.")
export class BrowseFilesBase implements IPost, IAuthenticateRequest, IStageableRequest
{
    /** @description The directory to browse for files. */
    // @ApiMember(Description="The directory to browse for files.", IsRequired=true, Name="DirectoryType")
    public directoryType: DirectoryType;

    /** @description The credential to gain access on the ELMA server. */
    // @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
    public credential: ElmaCredential;

    /** @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.", Name="StagingEnabled")
    public stagingEnabled?: boolean;

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

/** @description Represents information about a file or directory. */
// @Api(Description="Represents information about a file or directory.")
export class FileMetadata implements IFileMetadata
{
    /** @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.", Name="Name")
    public name: string;

    /** @description The full path of the directory or file. */
    // @ApiMember(Description="The full path of the directory or file.", Name="FullName")
    public fullName: string;

    /** @description The time the current file or directory was last accessed. */
    // @ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")
    public lastAccessTime: string;

    /** @description The name of the file. */
    // @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
    public lastAccessTimeUtc: string;

    /** @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.", Name="LastAccessTime")
    public lastWriteTime: string;

    /** @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.", Name="LastWriteTimeUtc")
    public lastWriteTimeUtc: string;

    /** @description The size, in bytes, of the current file. */
    // @ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
    public length: number;

    /** @description The size, in bytes, of the current file. */
    // @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
    public userId: number;

    /** @description The file group id. */
    // @ApiMember(Description="The file group id.", Name="GroupId")
    public groupId: number;

    /** @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.", Name="OthersCanRead")
    public othersCanRead: boolean;

    /** @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.", Name="GroupCanExecute")
    public groupCanExecute: boolean;

    /** @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.", Name="GroupCanWrite")
    public groupCanWrite: boolean;

    /** @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.", Name="GroupCanRead")
    public groupCanRead: boolean;

    /** @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.", Name="OwnerCanExecute")
    public ownerCanExecute: boolean;

    /** @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.", Name="OwnerCanWrite")
    public ownerCanWrite: boolean;

    /** @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.", Name="OthersCanRead")
    public ownerCanRead: boolean;

    /** @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.", Name="OthersCanExecute")
    public othersCanExecute: boolean;

    /** @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.", Name="OthersCanWrite")
    public othersCanWrite: boolean;

    /** @description Extensions to the file attributes. */
    // @ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
    public extensions: { [index: string]: string; };

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

/** @description Encapsulates the results of browsing an ELMA server directory */
// @Api(Description="Encapsulates the results of browsing an ELMA server directory")
export class BrowseResponse
{
    /** @description The files from the file browse operation. */
    // @ApiMember(Description="The files from the file browse operation.", Name="Files")
    public files: FileMetadata[];

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

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

/** @description Represents a request to browse directories for files on the ELMA server. */
// @Api(Description="Represents a request to browse directories for files on the ELMA server.")
export class BrowseFiles extends BrowseFilesBase
{

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

TypeScript BrowseFiles DTOs

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

HTTP + OTHER

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

POST /sync/elma/files/browse HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

{"files":[{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","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 - 2023 PricewaterhouseCoopers GmbH Wirtschaftsprüfungsgesellschaft.
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.