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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<ListWebhookSubscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Ids>
</ListWebhookSubscriptions>

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

<ArrayOfSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses">
  <SubscriptionResponse>
    <History xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
      <d3p1:SubscriptionDeliveryResult>
        <d3p1:AttemptedDateUtc>0001-01-01T00:00:00</d3p1:AttemptedDateUtc>
        <d3p1:EventId>String</d3p1:EventId>
        <d3p1:Id>String</d3p1:Id>
        <d3p1:StatusCode>Continue</d3p1:StatusCode>
        <d3p1:StatusDescription>String</d3p1:StatusDescription>
        <d3p1:SubscriptionId>String</d3p1:SubscriptionId>
      </d3p1:SubscriptionDeliveryResult>
    </History>
    <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>
    <Subscription xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
      <d3p1:Config>
        <d3p1:ContentType>String</d3p1:ContentType>
        <d3p1:Secret>String</d3p1:Secret>
        <d3p1:Url>String</d3p1:Url>
      </d3p1:Config>
      <d3p1:CreatedById>String</d3p1:CreatedById>
      <d3p1:CreatedDateUtc>0001-01-01T00:00:00</d3p1:CreatedDateUtc>
      <d3p1:Event>String</d3p1:Event>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:IsActive>false</d3p1:IsActive>
      <d3p1:LastModifiedDateUtc>0001-01-01T00:00:00</d3p1:LastModifiedDateUtc>
      <d3p1:Name>String</d3p1:Name>
    </Subscription>
  </SubscriptionResponse>
</ArrayOfSubscriptionResponse>