Report Filing Service

<back to all web services

BatchCreateElmaCredentialsAsync

CreateCredentialsBatchAsync

Represents a service to create and register multiple ELMA credentials in an asynchronous operation.

Requires Authentication
The following routes are available for this 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 .other suffix or ?format=other

HTTP + OTHER

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.pwc.de 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"credentials":[{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"}],"publicKeyXml":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

[{"id":"String","credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]