Report Filing Service

<back to all web services

BatchRetrieveElmaCredentialsAsync

RetrieveCredentialsBatchAsync

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

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

/** @description Represents the search criteria for an ELMA credential. */
// @Api(Description="Represents the search criteria for an ELMA credential.")
export class CredentialSearchCriteria
{
    /** @description The unique identifier of the credential. */
    // @ApiMember(Description="The unique identifier of the credential.", Name="Id")
    public id: string;

    /** @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" */
    // @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 authSteuernummer: string;

    /** @description The account identifier of a BZSt-Online Portal (BOP) user.  10-character text field that may only contain numbers (0-9). */
    // @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 accountId: string;

    public constructor(init?: Partial<CredentialSearchCriteria>) { (Object as any).assign(this, init); }
}

/** @description Specfies a service to retrieve ELMA credentials. */
// @Api(Description="Specfies a service to retrieve ELMA credentials.")
export class BatchRetrieveElmaCredentialsBase implements IPost
{
    /** @description The parameters used to search for credentials. */
    // @ApiMember(Description="The parameters used to search for credentials.", IsRequired=true, Name="SearchCriteria")
    public searchCriteria: CredentialSearchCriteria[];

    public constructor(init?: Partial<BatchRetrieveElmaCredentialsBase>) { (Object as any).assign(this, init); }
}

/** @description Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria. */
// @Api(Description="Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria.")
export class BatchRetrieveElmaCredentialsAsync extends BatchRetrieveElmaCredentialsBase
{

    public constructor(init?: Partial<BatchRetrieveElmaCredentialsAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript BatchRetrieveElmaCredentialsAsync DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<BatchRetrieveElmaCredentialsAsync 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>
</BatchRetrieveElmaCredentialsAsync>
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>