Report Filing Service

ListWebhookSubscriptions

ListSubscriptionsWebhooksSync

Represents a request to retrieve all specified subscriptions.

The following routes are available for this service:
POST	/sync/webhooks/subscriptions/list

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

/**
* Specifies a request to retrieve all specified subscriptions.
*/
// @Api(Description="Specifies a request to retrieve all specified subscriptions.")
abstract class ListWebhookSubscriptionsBase implements IPost
{
    /**
    * The unique identifiers of the subscriptions.
    */
    // @ApiMember(Description="The unique identifiers of the subscriptions.", IsRequired=true, Name="Ids")
    List<String>? ids;

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

    fromMap(Map<String, dynamic> json) {
        ids = JsonConverters.fromJson(json['ids'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ids': JsonConverters.toJson(ids,'List<String>',context!)
    };

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

/**
* Represents a request to retrieve all specified subscriptions.
*/
// @Api(Description="Represents a request to retrieve all specified subscriptions.")
class ListWebhookSubscriptions extends ListWebhookSubscriptionsBase implements IConvertible
{
    ListWebhookSubscriptions();
    ListWebhookSubscriptions.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() => "ListWebhookSubscriptions";
    TypeContext? context = _ctx;
}

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

Dart ListWebhookSubscriptions 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.

POST /sync/webhooks/subscriptions/list HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"ids":["String"]}

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"}}}]