Report Filing Service
| POST | /async/webhooks/subscriptions/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 request to create webhook subscriptions from a user tax number, account ID and webhook events in an asynchronous operation.
*/
@Api(Description="Represents a request to create webhook subscriptions from a user tax number, account ID and webhook events in an asynchronous operation.")
public static class CreateWebhookSubscriptionsAsync extends CreateWebhookSubscriptionsBase
{
}
/**
* Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.
*/
@Api(Description="Specifies a request to create webhook subscriptions from a user tax number, account ID and webhook events.")
public static class CreateWebhookSubscriptionsBase implements IPost, IConfigurable
{
/**
* The name of the subscription.
*/
@ApiMember(Description="The name of the subscription.", Name="Name")
public String name = 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")
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")
public String accountId = null;
/**
* The names of the subscribed events. .A subscriber can subscribe to more than one event.
*/
@ApiMember(Description="The names of the subscribed events. .A subscriber can subscribe to more than one event.", IsRequired=true, Name="Events")
public ArrayList<String> events = null;
/**
* The callback URL to be called when an "event" of a certain type is going to be raised.
*/
@ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", IsRequired=true, Name="Url")
public String url = null;
/**
* The MIME type of content pushed to the recipient service e.g. application/json
*/
@ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")
public String contentType = null;
/**
* A random Base64-encoded secret key (8 or more characters) to sign and authenticate messages from webhook endpoints. .When receiving a webhook event in your subscribers service, calculate the HMAC signature of the request body using this secret. Compare the calculated signature with the signature included in the "X-Hub-Signature" header of the web hook event. If the signatures do not match, then disregard it, and don't process the request any further.
*/
@ApiMember(Description="A random Base64-encoded secret key (8 or more characters) to sign and authenticate messages from webhook endpoints. .When receiving a webhook event in your subscribers service, calculate the HMAC signature of the request body using this secret. Compare the calculated signature with the signature included in the \"X-Hub-Signature\" header of the web hook event. If the signatures do not match, then disregard it, and don't process the request any further.", IsRequired=true, Name="Secret")
public String secret = null;
/**
* The XML-encoded RSA public key to encrypt the secret of the webhook subscription. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted secret with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.
*/
@ApiMember(Description="The XML-encoded RSA public key to encrypt the secret of the webhook subscription. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted secret with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.", IsRequired=true, Name="PublicKeyXml")
public String publicKeyXml = null;
public String getName() { return name; }
public CreateWebhookSubscriptionsBase setName(String value) { this.name = value; return this; }
public String getAuthSteuernummer() { return authSteuernummer; }
public CreateWebhookSubscriptionsBase setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
public String getAccountId() { return accountId; }
public CreateWebhookSubscriptionsBase setAccountId(String value) { this.accountId = value; return this; }
public ArrayList<String> getEvents() { return events; }
public CreateWebhookSubscriptionsBase setEvents(ArrayList<String> value) { this.events = value; return this; }
public String getUrl() { return url; }
public CreateWebhookSubscriptionsBase setUrl(String value) { this.url = value; return this; }
public String getContentType() { return contentType; }
public CreateWebhookSubscriptionsBase setContentType(String value) { this.contentType = value; return this; }
public String getSecret() { return secret; }
public CreateWebhookSubscriptionsBase setSecret(String value) { this.secret = value; return this; }
public String getPublicKeyXml() { return publicKeyXml; }
public CreateWebhookSubscriptionsBase setPublicKeyXml(String value) { this.publicKeyXml = value; return this; }
}
}
Java CreateWebhookSubscriptionsAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/webhooks/subscriptions/create HTTP/1.1
Host: reportfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
name: String,
authSteuernummer: String,
accountId: String,
events:
[
String
],
url: String,
contentType: String,
secret: String,
publicKeyXml: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
subscription:
{
id: String,
name: String,
event: String,
isActive: False,
createdDateUtc: 0001-01-01,
createdById: String,
lastModifiedDateUtc: 0001-01-01,
config:
{
url: String,
contentType: String,
secret: String
}
},
history:
[
{
attemptedDateUtc: 0001-01-01,
statusDescription: String,
statusCode: Continue,
subscriptionId: String,
id: String,
eventId: String
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}
]