Report Filing Service
| POST | /async/elma/credentials/batch/create |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Elmaas.Core.Services.Contracts.Credentials.Requests;
using PwC.Elmaas.Core.Domain.Concretes.Models;
using PwC.Elmaas.Core.Domain.Contracts.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; }
}
}
namespace PwC.Elmaas.Core.Services.Contracts.Credentials.Requests
{
///<summary>
///Represents a service to create and register multiple ELMA credentials in an asynchronous operation.
///</summary>
[Api(Description="Represents a service to create and register multiple ELMA credentials in an asynchronous operation.")]
public partial class BatchCreateElmaCredentialsAsync
: BatchCreateElmaCredentialsBase
{
}
///<summary>
///Specfies a service to create and register multiple ELMA credentials.
///</summary>
[Api(Description="Specfies a service to create and register multiple ELMA credentials.")]
public partial class BatchCreateElmaCredentialsBase
: IPost
{
public BatchCreateElmaCredentialsBase()
{
Credentials = new List<ElmaCredential>{};
}
///<summary>
///The ELMA credentials to create and register.
///</summary>
[ApiMember(Description="The ELMA credentials to create and register.", IsRequired=true, Name="Credentials")]
public virtual List<ElmaCredential> Credentials { get; set; }
///<summary>
///The XML-encoded RSA public key to encrypt the password of the credential. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted password with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.
///</summary>
[ApiMember(Description="The XML-encoded RSA public key to encrypt the password of the credential. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted password with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.", IsRequired=true, Name="PublicKeyXml")]
public virtual string PublicKeyXml { get; set; }
}
}
C# BatchCreateElmaCredentialsAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/elma/credentials/batch/create HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchCreateElmaCredentialsAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Credentials.Requests">
<Credentials xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
<d2p1:ElmaCredential>
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
<d2p1:Certificate xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
<d4p1:Content>String</d4p1:Content>
<d4p1:Description>String</d4p1:Description>
<d4p1:Id>String</d4p1:Id>
<d4p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d4p1:Tags>
</d2p1:Certificate>
<d2p1:Password>String</d2p1:Password>
</d2p1:ElmaCredential>
</Credentials>
<PublicKeyXml>String</PublicKeyXml>
</BatchCreateElmaCredentialsAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfElmaCredentialResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Credentials.Responses">
<ElmaCredentialResponse>
<Credential xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
<d3p1:AccountId>String</d3p1:AccountId>
<d3p1:AuthSteuernummer>String</d3p1:AuthSteuernummer>
<d3p1:Certificate xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
<d4p1:Content>String</d4p1:Content>
<d4p1:Description>String</d4p1:Description>
<d4p1:Id>String</d4p1:Id>
<d4p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d4p1:Tags>
</d3p1:Certificate>
<d3p1:Password>String</d3p1:Password>
</Credential>
<Id>String</Id>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d3p1:Meta>
</ResponseStatus>
</ElmaCredentialResponse>
</ArrayOfElmaCredentialResponse>