Report Filing Service
| POST | /async/elma/dac6/protocols/batch/retrieve |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Elmaas.Core.Services.Contracts.Dac6.Requests;
using PwC.Elmaas.Core.Services.Contracts.Requests;
using PwC.Elmaas.Core.Domain.Contracts.Models;
using PwC.Elmaas.Core.Domain.Concretes.Models;
using PwC.Elmaas.Core.Services.Contracts.Responses;
using PwC.DigitalHub.Utilities.IO.Concretes.Models;
using PwC.DigitalHub.Utilities.IO.Core.Contracts.Models;
using PwC.DigitalHub.Utilities.IO.Core.Concretes.Models;
namespace PwC.DigitalHub.Utilities.IO.Concretes.Models
{
///<summary>
///Represents a file that contains raw data content in bytes
///</summary>
[Api(Description="Represents a file that contains raw data content in bytes")]
public partial class BinaryFile
: FileBase
{
///<summary>
///The attributes of the file.
///</summary>
[ApiMember(Description="The attributes of the file.", Name="Metadata")]
public virtual FileMetadata Metadata { get; set; }
///<summary>
///The name of the file without information on its directory path.
///</summary>
[ApiMember(Description="The name of the file without information on its directory path.", Name="Name")]
public virtual string Name { get; set; }
}
}
namespace PwC.DigitalHub.Utilities.IO.Core.Concretes.Models
{
///<summary>
///Represents information about a file or directory.
///</summary>
[Api(Description="Represents information about a file or directory.")]
public partial class FileMetadata
: IFileMetadata
{
public FileMetadata()
{
Extensions = new Dictionary<string, string>{};
}
///<summary>
///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.
///</summary>
[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")]
public virtual string Name { get; set; }
///<summary>
///The full path of the directory or file.
///</summary>
[ApiMember(Description="The full path of the directory or file.", Name="FullName")]
public virtual string FullName { get; set; }
///<summary>
///The time the current file or directory was last accessed.
///</summary>
[ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")]
public virtual DateTime LastAccessTime { get; set; }
///<summary>
///The name of the file.
///</summary>
[ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")]
public virtual DateTime LastAccessTimeUtc { get; set; }
///<summary>
///The time when the current file or directory was last written to.
///</summary>
[ApiMember(Description="The time when the current file or directory was last written to.", Name="LastAccessTime")]
public virtual DateTime LastWriteTime { get; set; }
///<summary>
///The time, in coordinated universal time (UTC), when the current file or directory was last written to.
///</summary>
[ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.", Name="LastWriteTimeUtc")]
public virtual DateTime LastWriteTimeUtc { get; set; }
///<summary>
///The size, in bytes, of the current file.
///</summary>
[ApiMember(Description="The size, in bytes, of the current file.", Name="Length")]
public virtual long Length { get; set; }
///<summary>
///The size, in bytes, of the current file.
///</summary>
[ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")]
public virtual int UserId { get; set; }
///<summary>
///The file group id.
///</summary>
[ApiMember(Description="The file group id.", Name="GroupId")]
public virtual int GroupId { get; set; }
///<summary>
///A value that indicates whether the others can read from this file.
///</summary>
[ApiMember(Description="A value that indicates whether the others can read from this file.", Name="OthersCanRead")]
public virtual bool OthersCanRead { get; set; }
///<summary>
///A value that indicates whether the group members can execute this file.
///</summary>
[ApiMember(Description="A value that indicates whether the group members can execute this file.", Name="GroupCanExecute")]
public virtual bool GroupCanExecute { get; set; }
///<summary>
///A value that indicates whether the group members can write into this file.
///</summary>
[ApiMember(Description="A value that indicates whether the group members can write into this file.", Name="GroupCanWrite")]
public virtual bool GroupCanWrite { get; set; }
///<summary>
///A value that indicates whether the group members can read from this file.
///</summary>
[ApiMember(Description="A value that indicates whether the group members can read from this file.", Name="GroupCanRead")]
public virtual bool GroupCanRead { get; set; }
///<summary>
///A value that indicates whether the owner can execute this file.
///</summary>
[ApiMember(Description="A value that indicates whether the owner can execute this file.", Name="OwnerCanExecute")]
public virtual bool OwnerCanExecute { get; set; }
///<summary>
///A value that indicates whether the owner can write into this file.
///</summary>
[ApiMember(Description="A value that indicates whether the owner can write into this file.", Name="OwnerCanWrite")]
public virtual bool OwnerCanWrite { get; set; }
///<summary>
///A value that indicates whether the owner can read from this file.
///</summary>
[ApiMember(Description="A value that indicates whether the owner can read from this file.", Name="OthersCanRead")]
public virtual bool OwnerCanRead { get; set; }
///<summary>
///A value that indicates whether others can read from this file.
///</summary>
[ApiMember(Description="A value that indicates whether others can read from this file.", Name="OthersCanExecute")]
public virtual bool OthersCanExecute { get; set; }
///<summary>
///A value that indicates whether others can write into this file.
///</summary>
[ApiMember(Description="A value that indicates whether others can write into this file.", Name="OthersCanWrite")]
public virtual bool OthersCanWrite { get; set; }
///<summary>
///Extensions to the file attributes.
///</summary>
[ApiMember(Description="Extensions to the file attributes.", Name="Extensions")]
public virtual Dictionary<string, string> Extensions { get; set; }
}
}
namespace PwC.DigitalHub.Utilities.IO.Core.Contracts.Models
{
///<summary>
///Represents a base class for a file with raw data.
///</summary>
[Api(Description="Represents a base class for a file with raw data.")]
public partial class FileBase
{
public FileBase()
{
Content = new byte[]{};
}
///<summary>
///The raw data content of the file.
///</summary>
[ApiMember(Description="The raw data content of the file.", Name="Content")]
public virtual byte[] Content { get; set; }
}
}
namespace PwC.Elmaas.Core.Domain.Concretes.Models
{
///<summary>
///Represents an ELMA report document.
///</summary>
[Api(Description="Represents an ELMA report document.")]
public partial class Elma
{
///<summary>
///The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
///</summary>
[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")]
public virtual string Id { get; set; }
///<summary>
///The location of the XML Schema to use for the root namespace.
///</summary>
[ApiMember(Description="The location of the XML Schema to use for the root namespace.", Name="SchemaLocation")]
public virtual string SchemaLocation { get; set; }
///<summary>
///The type of reporting process.
///</summary>
[ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren")]
public virtual Verfahren? Verfahren { get; set; }
///<summary>
///The communication section of the ELMA report document.
///</summary>
[ApiMember(Description="The communication section of the ELMA report document.", IsRequired=true, Name="ElmaKom")]
public virtual ElmaKom ElmaKom { get; set; }
///<summary>
///The communication section of the ELMA report document.
///</summary>
[ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll")]
public virtual ElmaProtokoll ElmaProtokoll { get; set; }
///<summary>
///The communication section of the ELMA report document.
///</summary>
[ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler")]
public virtual ElmaFehler ElmaFehler { get; set; }
}
///<summary>
///Represents the credentials of a user to authenticate the access of an ELMA server.
///</summary>
[Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")]
public partial class ElmaCredential
: IElmaCredential
{
///<summary>
///The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
///</summary>
[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")]
public virtual string Id { get; set; }
///<summary>
///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)
///</summary>
[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(int.MaxValue)]
public virtual PemCertificate Certificate { get; set; }
///<summary>
///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"
///</summary>
[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)]
public virtual string AuthSteuernummer { get; set; }
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[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)]
public virtual string AccountId { get; set; }
///<summary>
///The password to protect the certificate from unauthorized access.
///</summary>
[ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")]
public virtual string Password { get; set; }
}
///<summary>
///Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
///</summary>
[Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")]
public partial class ElmaFehler
{
///<summary>
///File name of the processed input ELMA report.
///</summary>
[ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")]
public virtual string Dateiname { get; set; }
///<summary>
///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"
///</summary>
[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")]
public virtual string AuthSteuernummer { get; set; }
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[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")]
public virtual string AccountId { get; set; }
///<summary>
///Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
///</summary>
[ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")]
public virtual DateTime? VerarbeitungsDatum { get; set; }
///<summary>
///Time of processing by ELAN (ELMA receiving server at BZSt).
///</summary>
[ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")]
public virtual DateTime? VerarbeitungsZeit { get; set; }
///<summary>
///The status code of the ELMA process.
///</summary>
[ApiMember(Description="The status code of the ELMA process.", Name="FehlerID")]
public virtual Status FehlerID { get; set; }
///<summary>
///A brief description of the error status.
///</summary>
[ApiMember(Description="A brief description of the error status.", Name="FehlerText")]
public virtual string FehlerText { get; set; }
///<summary>
///A detailed information on the status.
///</summary>
[ApiMember(Description="A detailed information on the status.", Name="FehlerProzess")]
public virtual string FehlerProzess { get; set; }
///<summary>
///User custom ID.This field can be filled with internal reference information of the user.
///</summary>
[ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")]
public virtual string KundeneigeneId { get; set; }
///<summary>
///Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
///</summary>
[ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")]
public virtual Guid? UUID { get; set; }
}
///<summary>
///Represents the header of an ELMA communication section.
///</summary>
[Api(Description="Represents the header of an ELMA communication section.")]
public partial class ElmaHeader
{
///<summary>
///The process-specific report type of an ELMA document.It distinguishes by the type of input.
///</summary>
[ApiMember(Description="The process-specific report type of an ELMA document.It distinguishes by the type of input.", IsRequired=true, Name="DatenArt")]
public virtual DatenArt DatenArt { get; set; }
///<summary>
///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"
///</summary>
[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")]
public virtual string AuthSteuernummer { get; set; }
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[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")]
public virtual string AccountId { get; set; }
///<summary>
///The time of creation.Corresponds to the time, at which the user created a file.
///</summary>
[ApiMember(Description="The time of creation.Corresponds to the time, at which the user created a file.", Name="ErstellungsDatum")]
public virtual DateTime? ErstellungsDatum { get; set; }
///<summary>
///User custom ID.This field can be filled with internal reference information of the user.
///</summary>
[ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")]
public virtual string KundeneigeneId { get; set; }
///<summary>
///Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
///</summary>
[ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")]
public virtual Guid? UUID { get; set; }
///<summary>
///Distinguishes between test and live data transfer.
///</summary>
[ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf")]
public virtual Verarbeitungslauf Verarbeitungslauf { get; set; }
}
///<summary>
///Represents the communication section of an ELMA report document.
///</summary>
[Api(Description="Represents the communication section of an ELMA report document.")]
public partial class ElmaKom
{
///<summary>
///The version number of the ELMAKOM definition.
///</summary>
[ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion")]
public virtual string ElmakomVersion { get; set; }
///<summary>
///The header part of the ELMAKOM definition.
///</summary>
[ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader")]
public virtual ElmaHeader ElmaHeader { get; set; }
///<summary>
///The process part of the ELMAKOM definition.
///</summary>
[ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren")]
public virtual ElmaVerfahren ElmaVerfahren { get; set; }
}
///<summary>
///Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
///</summary>
[Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")]
public partial class ElmaProtokoll
{
///<summary>
///File name of the processed input ELMA report.
///</summary>
[ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")]
public virtual string Dateiname { get; set; }
///<summary>
///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"
///</summary>
[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")]
public virtual string AuthSteuernummer { get; set; }
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[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")]
public virtual string AccountId { get; set; }
///<summary>
///Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
///</summary>
[ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")]
public virtual DateTime? VerarbeitungsDatum { get; set; }
///<summary>
///Time of processing by ELAN (ELMA receiving server at BZSt).
///</summary>
[ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")]
public virtual DateTime? VerarbeitungsZeit { get; set; }
///<summary>
///The status code of the ELMA process.
///</summary>
[ApiMember(Description="The status code of the ELMA process.", Name="Status")]
public virtual Status Status { get; set; }
///<summary>
///A brief description of the status.
///</summary>
[ApiMember(Description="A brief description of the status.", Name="StatusText")]
public virtual string StatusText { get; set; }
///<summary>
///A detailed information on the status.
///</summary>
[ApiMember(Description="A detailed information on the status.", Name="StatusDetail")]
public virtual string StatusDetail { get; set; }
///<summary>
///User custom ID.This field can be filled with internal reference information of the user.
///</summary>
[ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")]
public virtual string KundeneigeneId { get; set; }
///<summary>
///Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
///</summary>
[ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")]
public virtual Guid? UUID { get; set; }
}
public partial class ElmaVerfahren
{
///<summary>
///The content of process-specific definition.
///</summary>
[ApiMember(Description="The content of process-specific definition.", Name="Inhalt")]
public virtual Object Inhalt { get; set; }
}
}
namespace PwC.Elmaas.Core.Domain.Contracts.Models
{
public enum DatenArt
{
ELMA_CC,
ELMA_CCRM,
ELMA_CRS,
ELMA_CRSRM,
ELMA_DC,
ELMA_DCRM,
ELMA_FC,
ELMA_FCRM,
}
///<summary>
///Represents a PEM-encoded certificate.
///</summary>
[Api(Description="Represents a PEM-encoded certificate.")]
public partial class PemCertificate
{
public PemCertificate()
{
Tags = new List<string>{};
}
///<summary>
///The unique identifier (e.g. the file name) of the certificate.
///</summary>
[ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")]
public virtual string Id { get; set; }
///<summary>
///The PEM-encoded content of the certificate.
///</summary>
[ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")]
public virtual string Content { get; set; }
///<summary>
///The description of the certificate.
///</summary>
[ApiMember(Description="The description of the certificate.", Name="Description")]
public virtual string Description { get; set; }
///<summary>
///Tags to label or identify the certificate.
///</summary>
[ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")]
public virtual List<string> Tags { get; set; }
}
public enum Status
{
ELMA_GLOBAL_UNBEKANNT = 0,
ELMA_OK = 8000,
ELMA_PARSER_FEHLER = 8001,
ELMA_UNGUELTIGE_KODIERUNG = 8002,
ELMA_UNGUELTIGE_DATEINAME = 8003,
ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID = 8004,
ELMA_SIGNATUR_DATEI_FEHLT = 8005,
ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT = 8006,
ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN = 8007,
ELMA_FREISCHALTUNG_FEHLT = 8008,
ELMA_SPERRE_VORHANDEN = 8009,
ELMA_DATEINAME_BEREITS_VERWENDET = 8010,
ELMA_DATEIINHALT_IDENTISCH = 8011,
ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN = 8012,
ELMA_TESTDATEN = 8013,
}
public enum Verarbeitungslauf
{
PRODUKTIONSLAUF,
TESTLAUF,
}
public enum Verfahren
{
CC,
CS,
DC,
FC,
FS,
FA,
KM,
}
}
namespace PwC.Elmaas.Core.Services.Contracts.Dac6.Requests
{
///<summary>
///Represents a request to retrieve process protocols for DAC6 in an asynchronous operation.
///</summary>
[Api(Description="Represents a request to retrieve process protocols for DAC6 in an asynchronous operation.")]
public partial class BatchRetrieveDac6ProtocolsAsync
: BatchRetrieveDac6ProtocolsBase
{
}
///<summary>
///Specifies a request to retrieve protocols of submitted DAC6 reports.
///</summary>
[Api(Description="Specifies a request to retrieve protocols of submitted DAC6 reports.")]
public partial class BatchRetrieveDac6ProtocolsBase
: IPost, IAuthenticateRequest, IStageableRequest, IBatchSearchRequest
{
public BatchRetrieveDac6ProtocolsBase()
{
SearchCriteria = new List<SearchCriteria>{};
}
///<summary>
///The parameters to search or filter the found protocols.
///</summary>
[ApiMember(Description="The parameters to search or filter the found protocols.", IsRequired=true, Name="SearchCriteria")]
public virtual List<SearchCriteria> SearchCriteria { get; set; }
///<summary>
///The credential to gain access on the ELMA server.
///</summary>
[ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")]
public virtual ElmaCredential Credential { get; set; }
///<summary>
///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.
///</summary>
[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")]
public virtual bool? StagingEnabled { get; set; }
}
}
namespace PwC.Elmaas.Core.Services.Contracts.Requests
{
///<summary>
///Represent parameters to search or filter on submissions.
///</summary>
[Api(Description="Represent parameters to search or filter on submissions. ")]
public partial class SearchCriteria
{
///<summary>
///Full or partial name of the item (report or protocol) to search.
///</summary>
[ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name")]
public virtual string Name { get; set; }
///<summary>
///TThe ELMA product designation.
///</summary>
[ApiMember(Description="TThe ELMA product designation.", Name="Designation")]
public virtual Verfahren? Designation { get; set; }
}
}
namespace PwC.Elmaas.Core.Services.Contracts.Responses
{
///<summary>
///Encapsulates the results of a protocol retrieval operation.
///</summary>
[Api(Description="Encapsulates the results of a protocol retrieval operation.")]
public partial class RetrievalResponse
{
public RetrievalResponse()
{
Protocols = new List<Elma>{};
Files = new List<BinaryFile>{};
}
///<summary>
///Processing logs that indicate the status of submitted reports.
///</summary>
[ApiMember(Description="Processing logs that indicate the status of submitted reports.", Name="Protocols")]
public virtual List<Elma> Protocols { get; set; }
///<summary>
///Other artefacts including the auxillary files from the BZSt.
///</summary>
[ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files")]
public virtual List<BinaryFile> Files { get; set; }
///<summary>
///The status of the response.
///</summary>
[ApiMember(Description="The status of the response.", Name="ResponseStatus")]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
C# BatchRetrieveDac6ProtocolsAsync DTOs
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 /async/elma/dac6/protocols/batch/retrieve HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
searchCriteria:
[
{
name: String,
designation: CC
}
],
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
{
protocols:
[
{
id: String,
schemaLocation: String,
verfahren: CC,
elmaKom:
{
elmakomVersion: String,
elmaHeader:
{
datenArt: ELMA_CC,
authSteuernummer: String,
accountId: String,
erstellungsDatum: 0001-01-01,
kundeneigeneId: String,
uuid: 00000000000000000000000000000000,
verarbeitungslauf: PRODUKTIONSLAUF
},
elmaVerfahren:
{
inhalt: {}
}
},
elmaProtokoll:
{
dateiname: String,
authSteuernummer: String,
accountId: String,
verarbeitungsDatum: 0001-01-01,
verarbeitungsZeit: 0001-01-01,
status: ELMA_GLOBAL_UNBEKANNT,
statusText: String,
statusDetail: String,
kundeneigeneId: String,
uuid: 00000000000000000000000000000000
},
elmaFehler:
{
dateiname: String,
authSteuernummer: String,
accountId: String,
verarbeitungsDatum: 0001-01-01,
verarbeitungsZeit: 0001-01-01,
fehlerID: ELMA_GLOBAL_UNBEKANNT,
fehlerText: String,
fehlerProzess: String,
kundeneigeneId: String,
uuid: 00000000000000000000000000000000
}
}
],
files:
[
{
metadata:
{
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
}
},
name: String,
content: AA==
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}