Report Filing Service

BatchRetrieveElmaCredentialsAsync

RetrieveCredentialsBatchAsync

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

The following routes are available for this service:
POST	/async/elma/credentials/batch

namespace PwC.Elmaas.Core.Services.Contracts.Credentials.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Represents the search criteria for an ELMA credential.
    ///</summary>
    [<Api(Description="Represents the search criteria for an ELMA credential.")>]
    [<AllowNullLiteral>]
    type CredentialSearchCriteria() = 
        ///<summary>
        ///The unique identifier of the credential.
        ///</summary>
        [<ApiMember(Description="The unique identifier of the credential.", Name="Id")>]
        member val Id:String = null with 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")>]
        member val AuthSteuernummer:String = null with 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")>]
        member val AccountId:String = null with get,set

    ///<summary>
    ///Specfies a service to retrieve ELMA credentials.
    ///</summary>
    [<Api(Description="Specfies a service to retrieve ELMA credentials.")>]
    [<AllowNullLiteral>]
    type BatchRetrieveElmaCredentialsBase() = 
        interface IPost
        ///<summary>
        ///The parameters used to search for credentials.
        ///</summary>
        [<ApiMember(Description="The parameters used to search for credentials.", IsRequired=true, Name="SearchCriteria")>]
        member val SearchCriteria:ResizeArray<CredentialSearchCriteria> = new ResizeArray<CredentialSearchCriteria>() with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type BatchRetrieveElmaCredentialsAsync() = 
        inherit BatchRetrieveElmaCredentialsBase()

F# BatchRetrieveElmaCredentialsAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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"}}}]