Report Filing Service

BatchDeleteFiles

DeleteFilesBatchSync

Represents a request to delete protocol files by using multiple search criteria and return the deleted files in a zip file.

The following routes are available for this service:
POST	/sync/elma/files/batch/delete

**BatchDeleteFilesBase** Parameters:
Name	Parameter	Data Type	Required	Description
SearchCriteria	form	List<SearchCriteria>	Yes	The parameters to search or filter the found protocols.
Credential	form	ElmaCredential	Yes	The credential to gain access on the ELMA server.
StagingEnabled	form	bool?	No	Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.

**SearchCriteria** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No	Full or partial name of the item (report or protocol) to search.
Designation	form	Verfahren?	No	TThe ELMA product designation.

**Verfahren** Enum:
CC
CS
DC
FC
FS
FA
KM

**ElmaCredential** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	Yes	The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
Certificate	form	PemCertificate	Yes	The security certificate to authenticate the user and grant access to the ELMA server. This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)
AuthSteuernummer	form	string	Yes	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"
AccountId	form	string	Yes	The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
Password	form	string	Yes	The password to protect the certificate from unauthorized access.

**PemCertificate** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	Yes	The unique identifier (e.g. the file name) of the certificate.
Content	form	string	Yes	The PEM-encoded content of the certificate.
Description	form	string	No	The description of the certificate.
Tags	form	List<string>	No	Tags to label or identify the certificate.

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 /sync/elma/files/batch/delete HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchDeleteFiles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Requests">
  <Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
    <d2p1:AccountId>String</d2p1:AccountId>
    <d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
    <d2p1:Certificate xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
      <d3p1:Content>String</d3p1:Content>
      <d3p1:Description>String</d3p1:Description>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:Tags>
    </d2p1:Certificate>
    <d2p1:Password>String</d2p1:Password>
  </Credential>
  <SearchCriteria>
    <SearchCriteria>
      <Designation>CC</Designation>
      <Name>String</Name>
    </SearchCriteria>
  </SearchCriteria>
  <StagingEnabled>false</StagingEnabled>
</BatchDeleteFiles>