Report Filing Service

<back to all web services

BatchRetrieveDac6Files

RetrieveFilesBatchDAC6Sync

Represents a request to retrieve protocols in a zip file using multiple search criteria.

Requires Authentication
The following routes are available for this service:
POST/sync/elma/dac6/files/batch/retrieve
BatchRetrieveFilesBase Parameters:
NameParameterData TypeRequiredDescription
SearchCriteriaformList<SearchCriteria>YesThe parameters to search or filter the found protocols.
CredentialformElmaCredentialYesThe credential to gain access on the ELMA server.
StagingEnabledformbool?NoShould 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:
NameParameterData TypeRequiredDescription
NameformstringNoFull or partial name of the item (report or protocol) to search.
DesignationformVerfahren?NoTThe ELMA product designation.
Verfahren Enum:
CC
CS
DC
FC
FS
FA
KM
ElmaCredential Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
CertificateformPemCertificateYesThe 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)
AuthSteuernummerformstringYesThe 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"
AccountIdformstringYesThe account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
PasswordformstringYesThe password to protect the certificate from unauthorized access.
PemCertificate Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier (e.g. the file name) of the certificate.
ContentformstringYesThe PEM-encoded content of the certificate.
DescriptionformstringNoThe description of the certificate.
TagsformList<string>NoTags to label or identify the certificate.

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

HTTP + JSV

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

POST /sync/elma/dac6/files/batch/retrieve HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	searchCriteria: 
	[
		{
			name: String,
			designation: CC
		}
	],
	credential: 
	{
		id: String_String,
		certificate: 
		{
			id: String,
			content: String,
			description: String,
			tags: 
			[
				String
			]
		},
		authSteuernummer: String,
		accountId: String,
		password: String
	},
	stagingEnabled: False
}