Report Filing Service
| POST | /async/elma/dac6/files/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;
namespace PwC.Elmaas.Core.Domain.Concretes.Models
{
///<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; }
}
}
namespace PwC.Elmaas.Core.Domain.Contracts.Models
{
///<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 Verfahren
{
CC,
CS,
DC,
FC,
FS,
FA,
KM,
}
}
namespace PwC.Elmaas.Core.Services.Contracts.Dac6.Requests
{
///<summary>
///Represents a request to retrieve DAC6 protocol files from the ELMA server in a zip file in an asynchronous operation.
///</summary>
[Api(Description="Represents a request to retrieve DAC6 protocol files from the ELMA server in a zip file in an asynchronous operation.")]
public partial class RetrieveDac6FilesAsync
: RetrieveDac6FilesBase
{
}
///<summary>
///Specifies a request to to retrieve DAC6 protocol files from the ELMA server in a zip file.
///</summary>
[Api(Description="Specifies a request to to retrieve DAC6 protocol files from the ELMA server in a zip file.")]
public partial class RetrieveDac6FilesBase
: IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest
{
///<summary>
///The parameters to search or filter on the protocols.
///</summary>
[ApiMember(Description="The parameters to search or filter on the protocols.", IsRequired=true, Name="SearchCriteria")]
public virtual 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; }
}
}
C# RetrieveDac6FilesAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/elma/dac6/files/retrieve HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length
{}