Report Filing Service
| POST | /sync/elma/credentials/batch/create |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
/**
* Represents a service to create and register multiple ELMA credentials.
*/
@Api(Description="Represents a service to create and register multiple ELMA credentials.")
public static class BatchCreateElmaCredentials extends BatchCreateElmaCredentialsBase
{
}
/**
* Specfies a service to create and register multiple ELMA credentials.
*/
@Api(Description="Specfies a service to create and register multiple ELMA credentials.")
public static class BatchCreateElmaCredentialsBase implements IPost
{
/**
* The ELMA credentials to create and register.
*/
@ApiMember(Description="The ELMA credentials to create and register.", IsRequired=true, Name="Credentials")
public ArrayList<ElmaCredential> credentials = null;
/**
* 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.
*/
@ApiMember(Description="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.", IsRequired=true, Name="PublicKeyXml")
public String publicKeyXml = null;
public ArrayList<ElmaCredential> getCredentials() { return credentials; }
public BatchCreateElmaCredentialsBase setCredentials(ArrayList<ElmaCredential> value) { this.credentials = value; return this; }
public String getPublicKeyXml() { return publicKeyXml; }
public BatchCreateElmaCredentialsBase setPublicKeyXml(String value) { this.publicKeyXml = value; return this; }
}
/**
* Represents the credentials of a user to authenticate the access of an ELMA server.
*/
@Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
public static class ElmaCredential implements IElmaCredential
{
/**
* The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
*/
@ApiMember(Description="The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")
public String id = null;
/**
* 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)
*/
@ApiMember(Description="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)", IsRequired=true, Name="Certificate")
@Required()
@StringLength(2147483647)
public PemCertificate certificate = null;
/**
* 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"
*/
@ApiMember(Description="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\"", IsRequired=true, Name="AuthSteuernummer")
@Required()
@StringLength(11)
public String authSteuernummer = null;
/**
* The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
*/
@ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
@Required()
@StringLength(10)
public String accountId = null;
/**
* The password to protect the certificate from unauthorized access.
*/
@ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
public String password = null;
public String getId() { return id; }
public ElmaCredential setId(String value) { this.id = value; return this; }
public PemCertificate getCertificate() { return certificate; }
public ElmaCredential setCertificate(PemCertificate value) { this.certificate = value; return this; }
public String getAuthSteuernummer() { return authSteuernummer; }
public ElmaCredential setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
public String getAccountId() { return accountId; }
public ElmaCredential setAccountId(String value) { this.accountId = value; return this; }
public String getPassword() { return password; }
public ElmaCredential setPassword(String value) { this.password = value; return this; }
}
/**
* Represents a PEM-encoded certificate.
*/
@Api(Description="Represents a PEM-encoded certificate.")
public static class PemCertificate
{
/**
* The unique identifier (e.g. the file name) of the certificate.
*/
@ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
public String id = null;
/**
* The PEM-encoded content of the certificate.
*/
@ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
public String content = null;
/**
* The description of the certificate.
*/
@ApiMember(Description="The description of the certificate.", Name="Description")
public String description = null;
/**
* Tags to label or identify the certificate.
*/
@ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
public ArrayList<String> tags = null;
public String getId() { return id; }
public PemCertificate setId(String value) { this.id = value; return this; }
public String getContent() { return content; }
public PemCertificate setContent(String value) { this.content = value; return this; }
public String getDescription() { return description; }
public PemCertificate setDescription(String value) { this.description = value; return this; }
public ArrayList<String> getTags() { return tags; }
public PemCertificate setTags(ArrayList<String> value) { this.tags = value; return this; }
}
}
Java BatchCreateElmaCredentials DTOs
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 /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>