Report Filing Service

<back to all web services

BatchDeleteWebhookSubscriptions

DeleteBatchSubscriptionsWebhooksSync

Represents a request to delete webhook subscriptions.

Requires Authentication
The following routes are available for this service:
POST/sync/webhooks/subscriptions/delete
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionConfig:
    url: Optional[str] = None
    content_type: Optional[str] = None
    secret: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebhookSubscription:
    id: Optional[str] = None
    name: Optional[str] = None
    event: Optional[str] = None
    is_active: bool = False
    created_date_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by_id: Optional[str] = None
    last_modified_date_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    config: Optional[SubscriptionConfig] = None


# @Api(Description="Specifies a request to delete webhook subscriptions.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchDeleteWebhookSubscriptionsBase(IReturn[List[SubscriptionResponse]], IPost):
    """
    Specifies a request to delete webhook subscriptions.
    """

    # @ApiMember(Description="The subscriptions to delete.", IsRequired=true, Name="Subscriptions")
    subscriptions: Optional[List[WebhookSubscription]] = None
    """
    The subscriptions to delete.
    """
    @staticmethod
    def response_type(): return List[SubscriptionResponse]


# @Api(Description="Represents a request to delete webhook subscriptions.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchDeleteWebhookSubscriptions(BatchDeleteWebhookSubscriptionsBase):
    """
    Represents a request to delete webhook subscriptions.
    """

    pass

Python BatchDeleteWebhookSubscriptions DTOs

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

HTTP + OTHER

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

POST /sync/webhooks/subscriptions/delete HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"subscriptions":[{"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"}}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}]