Report Filing Service
| POST | /sync/elma/files/browse |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DirectoryType | form | DirectoryType | Yes | The directory to browse for files. |
| Credential | form | ElmaCredential | Yes | The credential to gain access on the ELMA server. |
| StagingEnabled | form | bool? | No | 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. |
| Upload | |
| Download |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. |
| Certificate | form | PemCertificate | Yes | 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) |
| AuthSteuernummer | form | string | Yes | 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" |
| AccountId | form | string | Yes | The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). |
| Password | form | string | Yes | The password to protect the certificate from unauthorized access. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | The unique identifier (e.g. the file name) of the certificate. |
| Content | form | string | Yes | The PEM-encoded content of the certificate. |
| Description | form | string | No | The description of the certificate. |
| Tags | form | List<string> | No | Tags to label or identify the certificate. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Files | form | List<FileMetadata> | No | The files from the file browse operation. |
| ResponseStatus | form | ResponseStatus | No | The status of the file browse operation. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | 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. |
| FullName | form | string | No | The full path of the directory or file. |
| LastAccessTime | form | DateTime | No | The time the current file or directory was last accessed. |
| LastAccessTimeUtc | form | DateTime | No | The name of the file. |
| LastWriteTime | form | DateTime | No | The time when the current file or directory was last written to. |
| LastWriteTimeUtc | form | DateTime | No | The time, in coordinated universal time (UTC), when the current file or directory was last written to. |
| Length | form | long | No | The size, in bytes, of the current file. |
| UserId | form | int | No | The size, in bytes, of the current file. |
| GroupId | form | int | No | The file group id. |
| OthersCanRead | form | bool | No | A value that indicates whether the others can read from this file. |
| GroupCanExecute | form | bool | No | A value that indicates whether the group members can execute this file. |
| GroupCanWrite | form | bool | No | A value that indicates whether the group members can write into this file. |
| GroupCanRead | form | bool | No | A value that indicates whether the group members can read from this file. |
| OwnerCanExecute | form | bool | No | A value that indicates whether the owner can execute this file. |
| OwnerCanWrite | form | bool | No | A value that indicates whether the owner can write into this file. |
| OwnerCanRead | form | bool | No | A value that indicates whether the owner can read from this file. |
| OthersCanExecute | form | bool | No | A value that indicates whether others can read from this file. |
| OthersCanWrite | form | bool | No | A value that indicates whether others can write into this file. |
| Extensions | form | Dictionary<string, string> | No | Extensions 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
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"}}}