POST | /async/elma/credentials/delete |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 that protects the credential certificate from unauthorized access. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | The unique identifier of the response. |
Credential | form | ElmaCredential | No | The encapsulated ELMA credential. |
ResponseStatus | form | ResponseStatus | No | The status of the response. |
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. |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/elma/credentials/delete HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DeleteElmaCredentialAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Credentials.Requests">
<AccountId>String</AccountId>
<AuthSteuernummer>String</AuthSteuernummer>
<Password>String</Password>
</DeleteElmaCredentialAsync>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ElmaCredentialResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Credentials.Responses"> <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> <Id>String</Id> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> </ElmaCredentialResponse>