<back to all web services

BatchRetrieveElmaCredentials

Represents a service to retrieve ELMA credentials 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 by using search criteria.
    ///</summary>
    [Api(Description="Represents a service to retrieve ELMA credentials by using search criteria.")]
    public partial class BatchRetrieveElmaCredentials
        : 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# BatchRetrieveElmaCredentials DTOs

POST /sync/elma/credentials/batch HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchRetrieveElmaCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Credentials.Requests">
  <SearchCriteria>
    <CredentialSearchCriteria>
      <AccountId>String</AccountId>
      <AuthSteuernummer>String</AuthSteuernummer>
      <Id>String</Id>
    </CredentialSearchCriteria>
  </SearchCriteria>
</BatchRetrieveElmaCredentials>

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>