Report Filing Service

SearchWebhookSubscriptions

SearchSubscriptionsWebhooksSync

Represents a request to get the subscriptions for a specific event.

The following routes are available for this service:
GET	/sync/webhooks/subscriptions/search

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Specifies a request to get the subscriptions for a specific event.
*/
// @Api(Description="Specifies a request to get the subscriptions for a specific event.")
abstract class SearchWebhookSubscriptionsBase implements IGet
{
    /**
    * 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="EventName")
    String? eventName;

    SearchWebhookSubscriptionsBase({this.eventName});
    SearchWebhookSubscriptionsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        eventName = json['eventName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'eventName': eventName
    };

    getTypeName() => "SearchWebhookSubscriptionsBase";
    TypeContext? context = _ctx;
}

/**
* Represents a request to get the subscriptions for a specific event.
*/
// @Api(Description="Represents a request to get the subscriptions for a specific event.")
class SearchWebhookSubscriptions extends SearchWebhookSubscriptionsBase implements IConvertible
{
    SearchWebhookSubscriptions();
    SearchWebhookSubscriptions.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() => "SearchWebhookSubscriptions";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
    'SearchWebhookSubscriptionsBase': TypeInfo(TypeOf.AbstractClass),
    'SearchWebhookSubscriptions': TypeInfo(TypeOf.Class, create:() => SearchWebhookSubscriptions()),
});

Dart SearchWebhookSubscriptions DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sync/webhooks/subscriptions/search HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/x-msgpack

HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

[{"subscription":{"id":"String","name":"String","event":"String","isActive":false,"createdDateUtc":"\/Date(-62135596800000-0000)\/","createdById":"String","lastModifiedDateUtc":"\/Date(-62135596800000-0000)\/","config":{"url":"String","contentType":"String","secret":"String"}},"history":[{"attemptedDateUtc":"\/Date(-62135596800000-0000)\/","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"}}}]