Report Filing 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 .x-msgpack suffix or ?format=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.staging.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"}}}]