<back to all web services
BatchCreateElmaCredentials
CreateCredentialsBatchSync
Represents a service to create and register multiple ELMA credentials.
The following routes are available for this service:POST | /sync/elma/credentials/batch/create | | |
---|
BatchCreateElmaCredentialsBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
Credentials | form | List<ElmaCredential> | Yes | The ELMA credentials to create and register. |
PublicKeyXml | form | string | Yes | The XML-encoded RSA public key to encrypt the password of the credential. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted password with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding. |
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/credentials/batch/create HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchCreateElmaCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Credentials.Requests">
<Credentials xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
<d2p1:ElmaCredential>
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
<d2p1: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>
</d2p1:Certificate>
<d2p1:Password>String</d2p1:Password>
</d2p1:ElmaCredential>
</Credentials>
<PublicKeyXml>String</PublicKeyXml>
</BatchCreateElmaCredentials>
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>