Report Filing Service
| POST | /sync/elma/files/browse |
|---|
"use strict";
/** @typedef {'Upload'|'Download'} */
export var DirectoryType;
(function (DirectoryType) {
DirectoryType["Upload"] = "Upload"
DirectoryType["Download"] = "Download"
})(DirectoryType || (DirectoryType = {}));
export class PemCertificate {
/** @param {{id?:string,content?:string,description?:string,tags?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The unique identifier (e.g. the file name) of the certificate. */
id;
/**
* @type {string}
* @description The PEM-encoded content of the certificate. */
content;
/**
* @type {string}
* @description The description of the certificate. */
description;
/**
* @type {string[]}
* @description Tags to label or identify the certificate. */
tags;
}
export class ElmaCredential {
/** @param {{id?:string,certificate?:PemCertificate,authSteuernummer?:string,accountId?:string,password?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. */
id;
/**
* @type {PemCertificate}
* @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) */
certificate;
/**
* @type {string}
* @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" */
authSteuernummer;
/**
* @type {string}
* @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
accountId;
/**
* @type {string}
* @description The password to protect the certificate from unauthorized access. */
password;
}
export class BrowseFilesBase {
/** @param {{directoryType?:DirectoryType,credential?:ElmaCredential,stagingEnabled?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {DirectoryType}
* @description The directory to browse for files. */
directoryType;
/**
* @type {ElmaCredential}
* @description The credential to gain access on the ELMA server. */
credential;
/**
* @type {?boolean}
* @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. */
stagingEnabled;
}
export class FileMetadata {
/** @param {{name?:string,fullName?:string,lastAccessTime?:string,lastAccessTimeUtc?:string,lastWriteTime?:string,lastWriteTimeUtc?:string,length?:number,userId?:number,groupId?:number,othersCanRead?:boolean,groupCanExecute?:boolean,groupCanWrite?:boolean,groupCanRead?:boolean,ownerCanExecute?:boolean,ownerCanWrite?:boolean,ownerCanRead?:boolean,othersCanExecute?:boolean,othersCanWrite?:boolean,extensions?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @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. */
name;
/**
* @type {?string}
* @description The full path of the directory or file. */
fullName;
/**
* @type {string}
* @description The time the current file or directory was last accessed. */
lastAccessTime;
/**
* @type {string}
* @description The name of the file. */
lastAccessTimeUtc;
/**
* @type {string}
* @description The time when the current file or directory was last written to. */
lastWriteTime;
/**
* @type {string}
* @description The time, in coordinated universal time (UTC), when the current file or directory was last written to. */
lastWriteTimeUtc;
/**
* @type {number}
* @description The size, in bytes, of the current file. */
length;
/**
* @type {number}
* @description The size, in bytes, of the current file. */
userId;
/**
* @type {number}
* @description The file group id. */
groupId;
/**
* @type {boolean}
* @description A value that indicates whether the others can read from this file. */
othersCanRead;
/**
* @type {boolean}
* @description A value that indicates whether the group members can execute this file. */
groupCanExecute;
/**
* @type {boolean}
* @description A value that indicates whether the group members can write into this file. */
groupCanWrite;
/**
* @type {boolean}
* @description A value that indicates whether the group members can read from this file. */
groupCanRead;
/**
* @type {boolean}
* @description A value that indicates whether the owner can execute this file. */
ownerCanExecute;
/**
* @type {boolean}
* @description A value that indicates whether the owner can write into this file. */
ownerCanWrite;
/**
* @type {boolean}
* @description A value that indicates whether the owner can read from this file. */
ownerCanRead;
/**
* @type {boolean}
* @description A value that indicates whether others can read from this file. */
othersCanExecute;
/**
* @type {boolean}
* @description A value that indicates whether others can write into this file. */
othersCanWrite;
/**
* @type {{ [index: string]: string; }}
* @description Extensions to the file attributes. */
extensions;
}
export class BrowseResponse {
/** @param {{files?:FileMetadata[],responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {FileMetadata[]}
* @description The files from the file browse operation. */
files;
/**
* @type {ResponseStatus}
* @description The status of the file browse operation. */
responseStatus;
}
export class BrowseFiles extends BrowseFilesBase {
/** @param {{directoryType?:DirectoryType,credential?:ElmaCredential,stagingEnabled?:boolean,directoryType?:DirectoryType,credential?:ElmaCredential,stagingEnabled?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {DirectoryType}
* @description The directory to browse for files. */
directoryType;
/**
* @type {ElmaCredential}
* @description The credential to gain access on the ELMA server. */
credential;
/**
* @type {?boolean}
* @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. */
stagingEnabled;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/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
}
}
}