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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* 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.")
open class BrowseFilesAsync : BrowseFilesBase()
{
}

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

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

    /**
    * 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")
    var stagingEnabled:Boolean? = null
}

enum class DirectoryType
{
    Upload,
    Download,
}

/**
* 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.")
open class ElmaCredential : IElmaCredential
{
    /**
    * 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 id:String? = null

    /**
    * 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 certificate:PemCertificate? = null

    /**
    * 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 authSteuernummer:String? = null

    /**
    * 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 accountId:String? = null

    /**
    * 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 password:String? = null
}

/**
* Represents a PEM-encoded certificate.
*/
@Api(Description="Represents a PEM-encoded certificate.")
open class PemCertificate
{
    /**
    * 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 id:String? = null

    /**
    * The PEM-encoded content of the certificate.
    */
    @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
    var content:String? = null

    /**
    * The description of the certificate.
    */
    @ApiMember(Description="The description of the certificate.", Name="Description")
    var description:String? = null

    /**
    * Tags to label or identify the certificate.
    */
    @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    var tags:ArrayList<String> = ArrayList<String>()
}

/**
* Encapsulates the results of browsing an ELMA server directory
*/
@Api(Description="Encapsulates the results of browsing an ELMA server directory")
open class BrowseResponse
{
    /**
    * The files from the file browse operation.
    */
    @ApiMember(Description="The files from the file browse operation.", Name="Files")
    var files:ArrayList<FileMetadata> = ArrayList<FileMetadata>()

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

/**
* Represents information about a file or directory.
*/
@Api(Description="Represents information about a file or directory.")
open class FileMetadata : IFileMetadata
{
    /**
    * 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")
    var name:String? = null

    /**
    * The full path of the directory or file.
    */
    @ApiMember(Description="The full path of the directory or file.", Name="FullName")
    var fullName:String? = null

    /**
    * The time the current file or directory was last accessed.
    */
    @ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")
    var lastAccessTime:Date? = null

    /**
    * The name of the file.
    */
    @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
    var lastAccessTimeUtc:Date? = null

    /**
    * 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")
    var lastWriteTime:Date? = null

    /**
    * 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")
    var lastWriteTimeUtc:Date? = null

    /**
    * The size, in bytes, of the current file.
    */
    @ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
    var length:Long? = null

    /**
    * The size, in bytes, of the current file.
    */
    @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
    var userId:Int? = null

    /**
    * The file group id.
    */
    @ApiMember(Description="The file group id.", Name="GroupId")
    var groupId:Int? = null

    /**
    * 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")
    var othersCanRead:Boolean? = null

    /**
    * 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")
    var groupCanExecute:Boolean? = null

    /**
    * 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")
    var groupCanWrite:Boolean? = null

    /**
    * 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")
    var groupCanRead:Boolean? = null

    /**
    * 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")
    var ownerCanExecute:Boolean? = null

    /**
    * 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")
    var ownerCanWrite:Boolean? = null

    /**
    * 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")
    var ownerCanRead:Boolean? = null

    /**
    * 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")
    var othersCanExecute:Boolean? = null

    /**
    * 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")
    var othersCanWrite:Boolean? = null

    /**
    * Extensions to the file attributes.
    */
    @ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
    var extensions:HashMap<String,String> = HashMap<String,String>()
}

Kotlin BrowseFilesAsync DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<BrowseFilesAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Requests">
  <Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
    <d2p1:AccountId>String</d2p1:AccountId>
    <d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
    <d2p1:Certificate xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
      <d3p1:Content>String</d3p1:Content>
      <d3p1:Description>String</d3p1:Description>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:Tags>
    </d2p1:Certificate>
    <d2p1:Password>String</d2p1:Password>
  </Credential>
  <DirectoryType>Upload</DirectoryType>
  <StagingEnabled>false</StagingEnabled>
</BrowseFilesAsync>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BrowseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Concretes.Models">
    <d2p1:FileMetadata>
      <d2p1:Extensions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Extensions>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:GroupCanExecute>false</d2p1:GroupCanExecute>
      <d2p1:GroupCanRead>false</d2p1:GroupCanRead>
      <d2p1:GroupCanWrite>false</d2p1:GroupCanWrite>
      <d2p1:GroupId>0</d2p1:GroupId>
      <d2p1:LastAccessTime>0001-01-01T00:00:00</d2p1:LastAccessTime>
      <d2p1:LastAccessTimeUtc>0001-01-01T00:00:00</d2p1:LastAccessTimeUtc>
      <d2p1:LastWriteTime>0001-01-01T00:00:00</d2p1:LastWriteTime>
      <d2p1:LastWriteTimeUtc>0001-01-01T00:00:00</d2p1:LastWriteTimeUtc>
      <d2p1:Length>0</d2p1:Length>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OthersCanExecute>false</d2p1:OthersCanExecute>
      <d2p1:OthersCanRead>false</d2p1:OthersCanRead>
      <d2p1:OthersCanWrite>false</d2p1:OthersCanWrite>
      <d2p1:OwnerCanExecute>false</d2p1:OwnerCanExecute>
      <d2p1:OwnerCanRead>false</d2p1:OwnerCanRead>
      <d2p1:OwnerCanWrite>false</d2p1:OwnerCanWrite>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:FileMetadata>
  </Files>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</BrowseResponse>
© 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.