<back to all web services

BatchRetrieveElmaCredentialsAsync

Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria.

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;

namespace PwC.Elmaas.Core.Services.Contracts.Credentials.Requests
{
    ///<summary>
    ///Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria.
    ///</summary>
    [Api(Description="Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria.")]
    public partial class BatchRetrieveElmaCredentialsAsync
        : BatchRetrieveElmaCredentialsBase
    {
    }

    ///<summary>
    ///Specfies a service to retrieve ELMA credentials.
    ///</summary>
    [Api(Description="Specfies a service to retrieve ELMA credentials.")]
    public partial class BatchRetrieveElmaCredentialsBase
        : IPost
    {
        public BatchRetrieveElmaCredentialsBase()
        {
            SearchCriteria = new List<CredentialSearchCriteria>{};
        }

        ///<summary>
        ///The parameters used to search for credentials.
        ///</summary>
        [ApiMember(Description="The parameters used to search for credentials.", IsRequired=true, Name="SearchCriteria")]
        public virtual List<CredentialSearchCriteria> SearchCriteria { get; set; }
    }

    ///<summary>
    ///Represents the search criteria for an ELMA credential.
    ///</summary>
    [Api(Description="Represents the search criteria for an ELMA credential.")]
    public partial class CredentialSearchCriteria
    {
        ///<summary>
        ///The unique identifier of the credential.
        ///</summary>
        [ApiMember(Description="The unique identifier of the credential.", Name="Id")]
        public virtual string Id { 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\"", 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).", Name="AccountId")]
        public virtual string AccountId { get; set; }
    }

}

C# BatchRetrieveElmaCredentialsAsync DTOs

POST /async/elma/credentials/batch HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"searchCriteria":[{"id":"String","authSteuernummer":"String","accountId":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}]