Report Filing Service
| POST | /async/elma/files/browse |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
enum DirectoryType
{
Upload,
Download,
}
/**
* Represents a PEM-encoded certificate.
*/
// @Api(Description="Represents a PEM-encoded certificate.")
class PemCertificate implements IConvertible
{
/**
* 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")
String? id;
/**
* The PEM-encoded content of the certificate.
*/
// @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
String? content;
/**
* The description of the certificate.
*/
// @ApiMember(Description="The description of the certificate.", Name="Description")
String? description;
/**
* Tags to label or identify the certificate.
*/
// @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
List<String>? tags;
PemCertificate({this.id,this.content,this.description,this.tags});
PemCertificate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
content = json['content'];
description = json['description'];
tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'content': content,
'description': description,
'tags': JsonConverters.toJson(tags,'List<String>',context!)
};
getTypeName() => "PemCertificate";
TypeContext? context = _ctx;
}
/**
* 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.")
class ElmaCredential implements IElmaCredential, IConvertible
{
/**
* 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")
String? id;
/**
* 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)
PemCertificate? certificate;
/**
* 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)
String? authSteuernummer;
/**
* 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)
String? accountId;
/**
* The password to protect the certificate from unauthorized access.
*/
// @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
String? password;
ElmaCredential({this.id,this.certificate,this.authSteuernummer,this.accountId,this.password});
ElmaCredential.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
certificate = JsonConverters.fromJson(json['certificate'],'PemCertificate',context!);
authSteuernummer = json['authSteuernummer'];
accountId = json['accountId'];
password = json['password'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'certificate': JsonConverters.toJson(certificate,'PemCertificate',context!),
'authSteuernummer': authSteuernummer,
'accountId': accountId,
'password': password
};
getTypeName() => "ElmaCredential";
TypeContext? context = _ctx;
}
/**
* 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.")
abstract class BrowseFilesBase implements IPost, IAuthenticateRequest, IStageableRequest
{
/**
* The directory to browse for files.
*/
// @ApiMember(Description="The directory to browse for files.", IsRequired=true, Name="DirectoryType")
DirectoryType? directoryType;
/**
* The credential to gain access on the ELMA server.
*/
// @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
ElmaCredential? credential;
/**
* 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")
bool? stagingEnabled;
BrowseFilesBase({this.directoryType,this.credential,this.stagingEnabled});
BrowseFilesBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
directoryType = JsonConverters.fromJson(json['directoryType'],'DirectoryType',context!);
credential = JsonConverters.fromJson(json['credential'],'ElmaCredential',context!);
stagingEnabled = json['stagingEnabled'];
return this;
}
Map<String, dynamic> toJson() => {
'directoryType': JsonConverters.toJson(directoryType,'DirectoryType',context!),
'credential': JsonConverters.toJson(credential,'ElmaCredential',context!),
'stagingEnabled': stagingEnabled
};
getTypeName() => "BrowseFilesBase";
TypeContext? context = _ctx;
}
/**
* Represents information about a file or directory.
*/
// @Api(Description="Represents information about a file or directory.")
class FileMetadata implements IFileMetadata, IConvertible
{
/**
* 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")
String? name;
/**
* The full path of the directory or file.
*/
// @ApiMember(Description="The full path of the directory or file.", Name="FullName")
String? fullName;
/**
* The time the current file or directory was last accessed.
*/
// @ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")
DateTime? lastAccessTime;
/**
* The name of the file.
*/
// @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
DateTime? lastAccessTimeUtc;
/**
* 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")
DateTime? lastWriteTime;
/**
* 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")
DateTime? lastWriteTimeUtc;
/**
* The size, in bytes, of the current file.
*/
// @ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
int? length;
/**
* The size, in bytes, of the current file.
*/
// @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
int? userId;
/**
* The file group id.
*/
// @ApiMember(Description="The file group id.", Name="GroupId")
int? groupId;
/**
* 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")
bool? othersCanRead;
/**
* 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")
bool? groupCanExecute;
/**
* 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")
bool? groupCanWrite;
/**
* 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")
bool? groupCanRead;
/**
* 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")
bool? ownerCanExecute;
/**
* 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")
bool? ownerCanWrite;
/**
* 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")
bool? ownerCanRead;
/**
* 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")
bool? othersCanExecute;
/**
* 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")
bool? othersCanWrite;
/**
* Extensions to the file attributes.
*/
// @ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
Map<String,String?>? extensions;
FileMetadata({this.name,this.fullName,this.lastAccessTime,this.lastAccessTimeUtc,this.lastWriteTime,this.lastWriteTimeUtc,this.length,this.userId,this.groupId,this.othersCanRead,this.groupCanExecute,this.groupCanWrite,this.groupCanRead,this.ownerCanExecute,this.ownerCanWrite,this.ownerCanRead,this.othersCanExecute,this.othersCanWrite,this.extensions});
FileMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
name = json['name'];
fullName = json['fullName'];
lastAccessTime = JsonConverters.fromJson(json['lastAccessTime'],'DateTime',context!);
lastAccessTimeUtc = JsonConverters.fromJson(json['lastAccessTimeUtc'],'DateTime',context!);
lastWriteTime = JsonConverters.fromJson(json['lastWriteTime'],'DateTime',context!);
lastWriteTimeUtc = JsonConverters.fromJson(json['lastWriteTimeUtc'],'DateTime',context!);
length = json['length'];
userId = json['userId'];
groupId = json['groupId'];
othersCanRead = json['othersCanRead'];
groupCanExecute = json['groupCanExecute'];
groupCanWrite = json['groupCanWrite'];
groupCanRead = json['groupCanRead'];
ownerCanExecute = json['ownerCanExecute'];
ownerCanWrite = json['ownerCanWrite'];
ownerCanRead = json['ownerCanRead'];
othersCanExecute = json['othersCanExecute'];
othersCanWrite = json['othersCanWrite'];
extensions = JsonConverters.toStringMap(json['extensions']);
return this;
}
Map<String, dynamic> toJson() => {
'name': name,
'fullName': fullName,
'lastAccessTime': JsonConverters.toJson(lastAccessTime,'DateTime',context!),
'lastAccessTimeUtc': JsonConverters.toJson(lastAccessTimeUtc,'DateTime',context!),
'lastWriteTime': JsonConverters.toJson(lastWriteTime,'DateTime',context!),
'lastWriteTimeUtc': JsonConverters.toJson(lastWriteTimeUtc,'DateTime',context!),
'length': length,
'userId': userId,
'groupId': groupId,
'othersCanRead': othersCanRead,
'groupCanExecute': groupCanExecute,
'groupCanWrite': groupCanWrite,
'groupCanRead': groupCanRead,
'ownerCanExecute': ownerCanExecute,
'ownerCanWrite': ownerCanWrite,
'ownerCanRead': ownerCanRead,
'othersCanExecute': othersCanExecute,
'othersCanWrite': othersCanWrite,
'extensions': extensions
};
getTypeName() => "FileMetadata";
TypeContext? context = _ctx;
}
/**
* Encapsulates the results of browsing an ELMA server directory
*/
// @Api(Description="Encapsulates the results of browsing an ELMA server directory")
class BrowseResponse implements IConvertible
{
/**
* The files from the file browse operation.
*/
// @ApiMember(Description="The files from the file browse operation.", Name="Files")
List<FileMetadata>? files;
/**
* The status of the file browse operation.
*/
// @ApiMember(Description="The status of the file browse operation.", Name="ResponseStatus")
ResponseStatus? responseStatus;
BrowseResponse({this.files,this.responseStatus});
BrowseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
files = JsonConverters.fromJson(json['files'],'List<FileMetadata>',context!);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'files': JsonConverters.toJson(files,'List<FileMetadata>',context!),
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "BrowseResponse";
TypeContext? context = _ctx;
}
/**
* 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.")
class BrowseFilesAsync extends BrowseFilesBase implements IConvertible
{
BrowseFilesAsync();
BrowseFilesAsync.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "BrowseFilesAsync";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'reportfiling.pwc.de', types: <String, TypeInfo> {
'DirectoryType': TypeInfo(TypeOf.Enum, enumValues:DirectoryType.values),
'PemCertificate': TypeInfo(TypeOf.Class, create:() => PemCertificate()),
'ElmaCredential': TypeInfo(TypeOf.Class, create:() => ElmaCredential()),
'BrowseFilesBase': TypeInfo(TypeOf.AbstractClass),
'FileMetadata': TypeInfo(TypeOf.Class, create:() => FileMetadata()),
'BrowseResponse': TypeInfo(TypeOf.Class, create:() => BrowseResponse()),
'List<FileMetadata>': TypeInfo(TypeOf.Class, create:() => <FileMetadata>[]),
'BrowseFilesAsync': TypeInfo(TypeOf.Class, create:() => BrowseFilesAsync()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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.pwc.de
Accept: text/csv
Content-Type: text/csv
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/csv
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"}}}