Report Filing Service
| GET | /async/webhooks/subscriptions/find |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
/**
* Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.
*/
// @Api(Description="Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.")
abstract class FindWebhookSubscriptionBase implements IGet
{
/**
* 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")
String? authSteuernummer;
/**
* 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")
String? accountId;
/**
* The unique identifier of the subscriber.
*/
// @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="EventName")
String? eventName;
FindWebhookSubscriptionBase({this.authSteuernummer,this.accountId,this.eventName});
FindWebhookSubscriptionBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
authSteuernummer = json['authSteuernummer'];
accountId = json['accountId'];
eventName = json['eventName'];
return this;
}
Map<String, dynamic> toJson() => {
'authSteuernummer': authSteuernummer,
'accountId': accountId,
'eventName': eventName
};
getTypeName() => "FindWebhookSubscriptionBase";
TypeContext? context = _ctx;
}
class SubscriptionConfig implements IConvertible
{
String? url;
String? contentType;
String? secret;
SubscriptionConfig({this.url,this.contentType,this.secret});
SubscriptionConfig.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
url = json['url'];
contentType = json['contentType'];
secret = json['secret'];
return this;
}
Map<String, dynamic> toJson() => {
'url': url,
'contentType': contentType,
'secret': secret
};
getTypeName() => "SubscriptionConfig";
TypeContext? context = _ctx;
}
class WebhookSubscription implements IConvertible
{
String? id;
String? name;
String? event;
bool? isActive;
DateTime? createdDateUtc;
String? createdById;
DateTime? lastModifiedDateUtc;
SubscriptionConfig? config;
WebhookSubscription({this.id,this.name,this.event,this.isActive,this.createdDateUtc,this.createdById,this.lastModifiedDateUtc,this.config});
WebhookSubscription.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
name = json['name'];
event = json['event'];
isActive = json['isActive'];
createdDateUtc = JsonConverters.fromJson(json['createdDateUtc'],'DateTime',context!);
createdById = json['createdById'];
lastModifiedDateUtc = JsonConverters.fromJson(json['lastModifiedDateUtc'],'DateTime',context!);
config = JsonConverters.fromJson(json['config'],'SubscriptionConfig',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'name': name,
'event': event,
'isActive': isActive,
'createdDateUtc': JsonConverters.toJson(createdDateUtc,'DateTime',context!),
'createdById': createdById,
'lastModifiedDateUtc': JsonConverters.toJson(lastModifiedDateUtc,'DateTime',context!),
'config': JsonConverters.toJson(config,'SubscriptionConfig',context!)
};
getTypeName() => "WebhookSubscription";
TypeContext? context = _ctx;
}
class SubscriptionDeliveryResult implements IConvertible
{
DateTime? attemptedDateUtc;
String? statusDescription;
HttpStatusCode? statusCode;
String? subscriptionId;
String? id;
String? eventId;
SubscriptionDeliveryResult({this.attemptedDateUtc,this.statusDescription,this.statusCode,this.subscriptionId,this.id,this.eventId});
SubscriptionDeliveryResult.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
attemptedDateUtc = JsonConverters.fromJson(json['attemptedDateUtc'],'DateTime',context!);
statusDescription = json['statusDescription'];
statusCode = JsonConverters.fromJson(json['statusCode'],'HttpStatusCode',context!);
subscriptionId = json['subscriptionId'];
id = json['id'];
eventId = json['eventId'];
return this;
}
Map<String, dynamic> toJson() => {
'attemptedDateUtc': JsonConverters.toJson(attemptedDateUtc,'DateTime',context!),
'statusDescription': statusDescription,
'statusCode': JsonConverters.toJson(statusCode,'HttpStatusCode',context!),
'subscriptionId': subscriptionId,
'id': id,
'eventId': eventId
};
getTypeName() => "SubscriptionDeliveryResult";
TypeContext? context = _ctx;
}
/**
* Represents a service response that encapsulates a webhook subscription.
*/
// @Api(Description="Represents a service response that encapsulates a webhook subscription.")
class SubscriptionResponse implements IConvertible
{
/**
* The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.
*/
// @ApiMember(Description="The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.", Name="Subscription")
WebhookSubscription? subscription;
/**
* The history of the subscription event.
*/
// @ApiMember(Description="The history of the subscription event.", Name="History")
List<SubscriptionDeliveryResult>? history;
/**
* The status of the response.
*/
// @ApiMember(Description="The status of the response.", Name="ResponseStatus")
ResponseStatus? responseStatus;
SubscriptionResponse({this.subscription,this.history,this.responseStatus});
SubscriptionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
subscription = JsonConverters.fromJson(json['subscription'],'WebhookSubscription',context!);
history = JsonConverters.fromJson(json['history'],'List<SubscriptionDeliveryResult>',context!);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'subscription': JsonConverters.toJson(subscription,'WebhookSubscription',context!),
'history': JsonConverters.toJson(history,'List<SubscriptionDeliveryResult>',context!),
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "SubscriptionResponse";
TypeContext? context = _ctx;
}
/**
* Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation.
*/
// @Api(Description="Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation.")
class FindWebhookSubscriptionAsync extends FindWebhookSubscriptionBase implements IConvertible
{
FindWebhookSubscriptionAsync();
FindWebhookSubscriptionAsync.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "FindWebhookSubscriptionAsync";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
'FindWebhookSubscriptionBase': TypeInfo(TypeOf.AbstractClass),
'SubscriptionConfig': TypeInfo(TypeOf.Class, create:() => SubscriptionConfig()),
'WebhookSubscription': TypeInfo(TypeOf.Class, create:() => WebhookSubscription()),
'SubscriptionDeliveryResult': TypeInfo(TypeOf.Class, create:() => SubscriptionDeliveryResult()),
'HttpStatusCode': TypeInfo(TypeOf.Class, create:() => HttpStatusCode()),
'SubscriptionResponse': TypeInfo(TypeOf.Class, create:() => SubscriptionResponse()),
'List<SubscriptionDeliveryResult>': TypeInfo(TypeOf.Class, create:() => <SubscriptionDeliveryResult>[]),
'FindWebhookSubscriptionAsync': TypeInfo(TypeOf.Class, create:() => FindWebhookSubscriptionAsync()),
});
Dart FindWebhookSubscriptionAsync 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.
GET /async/webhooks/subscriptions/find HTTP/1.1 Host: reportfiling.staging.pwc.de Accept: text/jsv
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
}
}
}