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
BrowseFilesBase Parameters:
NameParameterData TypeRequiredDescription
DirectoryTypeformDirectoryTypeYesThe directory to browse for files.
CredentialformElmaCredentialYesThe credential to gain access on the ELMA server.
StagingEnabledformbool?NoShould 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.
DirectoryType Enum:
Upload
Download
ElmaCredential Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
CertificateformPemCertificateYesThe 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)
AuthSteuernummerformstringYesThe 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"
AccountIdformstringYesThe account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
PasswordformstringYesThe password to protect the certificate from unauthorized access.
PemCertificate Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier (e.g. the file name) of the certificate.
ContentformstringYesThe PEM-encoded content of the certificate.
DescriptionformstringNoThe description of the certificate.
TagsformList<string>NoTags to label or identify the certificate.
BrowseResponse Parameters:
NameParameterData TypeRequiredDescription
FilesformList<FileMetadata>NoThe files from the file browse operation.
ResponseStatusformResponseStatusNoThe status of the file browse operation.
FileMetadata Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe 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.
FullNameformstringNoThe full path of the directory or file.
LastAccessTimeformDateTimeNoThe time the current file or directory was last accessed.
LastAccessTimeUtcformDateTimeNoThe name of the file.
LastWriteTimeformDateTimeNoThe time when the current file or directory was last written to.
LastWriteTimeUtcformDateTimeNoThe time, in coordinated universal time (UTC), when the current file or directory was last written to.
LengthformlongNoThe size, in bytes, of the current file.
UserIdformintNoThe size, in bytes, of the current file.
GroupIdformintNoThe file group id.
OthersCanReadformboolNoA value that indicates whether the others can read from this file.
GroupCanExecuteformboolNoA value that indicates whether the group members can execute this file.
GroupCanWriteformboolNoA value that indicates whether the group members can write into this file.
GroupCanReadformboolNoA value that indicates whether the group members can read from this file.
OwnerCanExecuteformboolNoA value that indicates whether the owner can execute this file.
OwnerCanWriteformboolNoA value that indicates whether the owner can write into this file.
OwnerCanReadformboolNoA value that indicates whether the owner can read from this file.
OthersCanExecuteformboolNoA value that indicates whether others can read from this file.
OthersCanWriteformboolNoA value that indicates whether others can write into this file.
ExtensionsformDictionary<string, string>NoExtensions to the file attributes.

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

HTTP + X-MSGPACK

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: application/x-msgpack
Content-Type: application/x-msgpack
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: application/x-msgpack
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"}}}