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 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


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

    # @ApiMember(Description="The unique identifiers of the subscriptions.", IsRequired=true, Name="Ids")
    ids: Optional[List[str]] = None
    """
    The unique identifiers of the subscriptions.
    """
    @staticmethod
    def response_type(): return List[SubscriptionResponse]


# @Api(Description="Represents a request to retrieve all specified subscriptions.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListWebhookSubscriptions(ListWebhookSubscriptionsBase):
    """
    Represents a request to retrieve all specified subscriptions.
    """

    pass

Python 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.staging.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"}}}]