<back to all web services
BatchSubmitFilesAsync
SubmitReportsFilesBatchAsync
Represents a request to submit report files to ELMa via HTTP file upload in an asynchronous operation.
The following routes are available for this service:POST | /async/elma/files/batch/submit | | |
---|
BatchSubmitFilesBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
Credential | form | ElmaCredential | Yes | The credential to gain access on the ELMA server. |
ValidationEnabled | form | bool | Yes | Should the report data be validated before sending it to the ELMA server? true: report data is validated before it is sent to the ELMA server. false: report data sent without validation to 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. |
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 /async/elma/files/batch/submit HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchSubmitFilesAsync 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>
<StagingEnabled>false</StagingEnabled>
<ValidationEnabled>false</ValidationEnabled>
</BatchSubmitFilesAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfSubmissionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
<SubmissionResponse>
<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>
<ValidationErrors xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
<d3p1:ValidationError>
<d3p1:Id>String</d3p1:Id>
<d3p1:LineNumber>0</d3p1:LineNumber>
<d3p1:LinePosition>0</d3p1:LinePosition>
<d3p1:Message>String</d3p1:Message>
<d3p1:Severity>Error</d3p1:Severity>
</d3p1:ValidationError>
</ValidationErrors>
<Xml>String</Xml>
</SubmissionResponse>
</ArrayOfSubmissionResponse>